From MAILER-DAEMON Mon Oct 18 16:55:37 2004 Received: from mailman by lists.gnu.org with archive (Exim 4.33) id 1CJeXY-00030H-RI for mharc-bug-gnupress@gnu.org; Mon, 18 Oct 2004 16:55:37 -0400 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.33) id 1CJeXX-0002zD-8R for bug-gnupress@gnu.org; Mon, 18 Oct 2004 16:55:35 -0400 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.33) id 1CJeXW-0002yZ-F3 for bug-gnupress@gnu.org; Mon, 18 Oct 2004 16:55:34 -0400 Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1CJeXW-0002yO-9q for bug-gnupress@gnu.org; Mon, 18 Oct 2004 16:55:34 -0400 Received: from [132.198.101.203] (helo=eagle.uvm.edu) by monty-python.gnu.org with esmtp (TLSv1:DES-CBC3-SHA:168) (Exim 4.34) id 1CJePz-0008I5-7a for bug-gnupress@gnu.org; Mon, 18 Oct 2004 16:47:47 -0400 Received: from gnu.uvm.edu (gnu.uvm.edu [132.198.101.64]) by eagle.uvm.edu (8.12.11/8.12.11) with ESMTP id i9IKlk6H010408 (version=TLSv1/SSLv3 cipher=EDH-RSA-DES-CBC3-SHA bits=168 verify=NO) for ; Mon, 18 Oct 2004 16:47:46 -0400 Date: Mon, 18 Oct 2004 16:47:45 -0400 (EDT) From: "Aaron S. Hawley" X-X-Sender: ashawley@gnu.uvm.edu To: bug-gnupress@gnu.org Message-ID: Organization: University of Vermont X-Mailer: Pine 4.58 http://www.washington.edu/pine/ MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII Subject: [Bug-gnupress] Style Guide feedback X-BeenThere: bug-gnupress@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: bug-gnupress.gnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 18 Oct 2004 20:55:35 -0000 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 From MAILER-DAEMON Fri Oct 22 17:44:17 2004 Received: from mailman by lists.gnu.org with archive (Exim 4.33) id 1CL7Cr-0002wP-Pa for mharc-bug-gnupress@gnu.org; Fri, 22 Oct 2004 17:44:17 -0400 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.33) id 1CL7Cq-0002wI-7I for bug-gnupress@gnu.org; Fri, 22 Oct 2004 17:44:16 -0400 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.33) id 1CL7Cp-0002w6-Nq for bug-gnupress@gnu.org; Fri, 22 Oct 2004 17:44:15 -0400 Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1CL7Cp-0002w3-KQ for bug-gnupress@gnu.org; Fri, 22 Oct 2004 17:44:15 -0400 Received: from [129.97.134.31] (helo=perpugilliam.csclub.uwaterloo.ca) by monty-python.gnu.org with esmtp (Exim 4.34) id 1CL75C-0007Ij-6l for bug-gnupress@gnu.org; Fri, 22 Oct 2004 17:36:22 -0400 Received: by perpugilliam.csclub.uwaterloo.ca (Postfix, from userid 20178) id 9A9F5A8661; Fri, 22 Oct 2004 17:36:21 -0400 (EDT) To: "Aaron S. Hawley" Subject: Re: [Bug-gnupress] Style Guide feedback References: From: ja2morri@csclub.uwaterloo.ca (James A. Morrison) Date: 22 Oct 2004 17:36:21 -0400 In-Reply-To: Message-ID: Lines: 58 User-Agent: Gnus/5.09 (Gnus v5.9.0) Emacs/21.2 MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Cc: bug-gnupress@gnu.org X-BeenThere: bug-gnupress@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: bug-gnupress.gnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 22 Oct 2004 21:44:16 -0000 "Aaron S. Hawley" 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. Is this document in CVS somewhere? Jim > 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 > Bug-gnupress@gnu.org > 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 From MAILER-DAEMON Sat Oct 23 10:47:03 2004 Received: from mailman by lists.gnu.org with archive (Exim 4.33) id 1CLNAd-00050J-Jb for mharc-bug-gnupress@gnu.org; Sat, 23 Oct 2004 10:47:03 -0400 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.33) id 1CLNAb-0004zi-7E for bug-gnupress@gnu.org; Sat, 23 Oct 2004 10:47:01 -0400 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.33) id 1CLNAa-0004zF-Cq for bug-gnupress@gnu.org; Sat, 23 Oct 2004 10:47:00 -0400 Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1CLNAY-0004z5-QH for bug-gnupress@gnu.org; Sat, 23 Oct 2004 10:46:59 -0400 Received: from [132.198.101.202] (helo=pony.uvm.edu) by monty-python.gnu.org with esmtp (TLSv1:DES-CBC3-SHA:168) (Exim 4.34) id 1CLN2x-0007oG-2c for bug-gnupress@gnu.org; Sat, 23 Oct 2004 10:39:07 -0400 Received: from gnu.uvm.edu (gnu.uvm.edu [132.198.101.64]) by pony.uvm.edu (8.12.11/8.12.11) with ESMTP id i9NEd5u7032143 (version=TLSv1/SSLv3 cipher=EDH-RSA-DES-CBC3-SHA bits=168 verify=NO) for ; Sat, 23 Oct 2004 10:39:05 -0400 Date: Sat, 23 Oct 2004 10:39:05 -0400 (EDT) From: "Aaron S. Hawley" X-X-Sender: ashawley@gnu.uvm.edu To: bug-gnupress@gnu.org Subject: Re: [Bug-gnupress] Style Guide feedback In-Reply-To: Message-ID: References: Organization: University of Vermont X-Mailer: Pine 4.58 http://www.washington.edu/pine/ MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII X-BeenThere: bug-gnupress@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: bug-gnupress.gnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 23 Oct 2004 14:47:01 -0000 On Fri, 22 Oct 2004, James A. Morrison wrote: > > "Aaron S. Hawley" 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. > > Is this document in CVS somewhere? it is on the web, so it is with the FSF's web savannah project, and is thus in its CVS. not sure if that means it's official CVS home. here's the page that adertises the document in question. http://www.gnu.org/doc/potentialauthors.html > > Jim From MAILER-DAEMON Sat Oct 23 11:26:34 2004 Received: from mailman by lists.gnu.org with archive (Exim 4.33) id 1CLNms-0007eF-Ml for mharc-bug-gnupress@gnu.org; Sat, 23 Oct 2004 11:26:34 -0400 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.33) id 1CLNmr-0007cE-75 for bug-gnupress@gnu.org; Sat, 23 Oct 2004 11:26:33 -0400 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.33) id 1CLNmq-0007be-Bx for bug-gnupress@gnu.org; Sat, 23 Oct 2004 11:26:32 -0400 Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1CLNmq-0007bV-7A for bug-gnupress@gnu.org; Sat, 23 Oct 2004 11:26:32 -0400 Received: from [129.97.134.31] (helo=perpugilliam.csclub.uwaterloo.ca) by monty-python.gnu.org with esmtp (Exim 4.34) id 1CLNeX-0004SU-N2; Sat, 23 Oct 2004 11:17:57 -0400 Received: by perpugilliam.csclub.uwaterloo.ca (Postfix, from userid 20178) id 57812A86EA; Sat, 23 Oct 2004 11:17:56 -0400 (EDT) To: opus@gnu.org, Subject: Re: [Bug-gnupress] Style Guide feedback References: From: ja2morri@csclub.uwaterloo.ca (James A. Morrison) Date: 23 Oct 2004 11:17:48 -0400 In-Reply-To: Message-ID: Lines: 60 User-Agent: Gnus/5.09 (Gnus v5.9.0) Emacs/21.2 MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Cc: bug-gnupress@gnu.org X-BeenThere: bug-gnupress@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: bug-gnupress.gnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 23 Oct 2004 15:26:33 -0000 Hi Lisa, I'm not sure if you saw this. Jim "Aaron S. Hawley" 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 > Bug-gnupress@gnu.org > 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