[debbugs-tracker] bug#10481: closed (Simple patches to Texinfo docs)

[GNU bug Tracking System]

Your message dated Thu, 02 Feb 2012 12:17:25 +0100
with message-id <address@hidden>
and subject line Re: bug#10481: Simple patches to Texinfo docs
has caused the debbugs.gnu.org bug report #10481,
regarding Simple patches to Texinfo docs
to be marked as done.

(If you believe you have received this mail in error, please contact
address@hidden)


-- 
10481: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=10481
GNU Bug Tracking System
Contact address@hidden with problems

--- Begin Message --- Subject: Simple patches to Texinfo docs Date: Wed, 11 Jan 2012 13:08:14 -0500 User-agent: Gnus/5.13 (Gnus v5.13) Emacs/24.0.92 (gnu/linux)

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
Description: Fix unbalanced parentheses in Texinfo docs

0001-Make-consistent-the-usage-of-variable-names-in-the.patch
Description: Make variable name usage more consistent in Texinfo docs

--- End Message ---

> --- Begin Message ---
>
>
>
> Subject: 
>
> Re: bug#10481: Simple patches to Texinfo docs
>
>
>
>
> Date: 
>
> Thu, 02 Feb 2012 12:17:25 +0100
>
>
>
>
> User-agent: 
>
> Gnus/5.13 (Gnus v5.13) Emacs/23.3 (gnu/linux)
>
>
>
>
> On Wed 11 Jan 2012 19:08, Bake Timmons <address@hidden> writes:
>
> > 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.
>
> Thank you!  I applied both of these patches.  Sorry we didn't get around
> to it until after the release; things were a bit hectic.
>
> Cheers,
>
> Andy
> -- 
> http://wingolog.org/
>
>
> --- End Message ---