[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Bug-gnupress] Style Guide feedback
From: |
James A. Morrison |
Subject: |
Re: [Bug-gnupress] Style Guide feedback |
Date: |
23 Oct 2004 11:17:48 -0400 |
User-agent: |
Gnus/5.09 (Gnus v5.9.0) Emacs/21.2 |
Hi Lisa,
I'm not sure if you saw this.
Jim
"Aaron S. Hawley" <address@hidden> writes:
> Style guide is a cool document. One helpful and humorous suggestion made
> is:
>
> * Examples are not "given" but "shown". Only useful stand-alone
> programs qualify as gifts.
>
> The patch below fixes the style guide's breaches of it's own suggestion:
>
> ===================================================================
> RCS file: RCS/GNU-Press-styleguide.texi,v
> retrieving revision 1.1
> diff -u -r1.1 GNU-Press-styleguide.texi
> --- GNU-Press-styleguide.texi 2003/05/06 15:21:03
> +++ GNU-Press-styleguide.texi 2004/10/18 20:30:51
> Tue, 06 May 2003 19:21:03 GMT
> @@ -157,7 +157,7 @@
> ``Parameters must have their types declared.'' Must @emph{all}
> parameters have their types declared? If so, say so; if not, state
> which parameters must have their types declared and which must not;
> -and give examples where necessary.
> +and show examples where necessary.
> @end itemize
>
> @node Ordering your text, Code examples, Basic points of style, Top
> @@ -257,7 +257,7 @@
>
> @itemize @bullet
> @item
> -Give sample output for code examples wherever possible.
> +Show sample output for code examples wherever possible.
>
> @item
> Don't waste the reader's time with frivolous examples that have no
>
>
>
> _______________________________________________
> Bug-gnupress mailing list
> address@hidden
> http://lists.gnu.org/mailman/listinfo/bug-gnupress
>
--
Thanks,
Jim
http://www.student.cs.uwaterloo.ca/~ja2morri/
http://phython.blogspot.com
http://open.nit.ca/wiki/?page=jim