GNU bug report logs - #10481
Simple patches to Texinfo docs

Previous Next

Full log

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Bake Timmons <b3timmons <at> speedymail.org>
To: bug-guile <at> gnu.org
Subject: Simple patches to Texinfo docs
Date: Wed, 11 Jan 2012 13:08:14 -0500

[Message part 1 (text/plain, inline)]

Hi,

Months ago I proposed some improvements to the manual.  With a gentle
reminder from Andy Wingo, I have finally started breaking up my original
giant patch into some manageable patches.  The first patch is nearly
trivial, and the second is simple changes to many files.

The second patch tries to make the usage of variable names more
consistent and goes after simple, blatant cases.  A hypothetical
example is

@deffn {Scheme Procedure} bitvector-ref vec idx
@deffnx {C Function} scm_bitvector_ref (vec, idx)
Return the element at index @var{idx} of the bit vector
@var{vector}.
@end deffn

We change "vector" to "vec" or vice versa.  There are a few cases where
names that are consistently used *within* a definition are still changed
to conform with usage in surrounding function definitions.

One way I plan to shorten patches is based on the kind of files to be
patched, .texinfo, .scm, .c, etc.  Thus, the next patches I will send
will be similar changes for docstrings in .scm and .c files.

Thanks for any comments!

Bake

[0001-Fix-unbalanced-parentheses-in-docs.patch (text/x-diff, attachment)]

[0001-Make-consistent-the-usage-of-variable-names-in-the.patch (text/x-diff, attachment)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.