delorie.com/archives/browse.cgi   search  
Mail Archives: djgpp-workers/2000/12/31/04:53:33

Date: Sun, 31 Dec 2000 11:51:22 +0200
From: "Eli Zaretskii" <eliz AT is DOT elta DOT co DOT il>
Sender: halo1 AT zahav DOT net DOT il
To: "Richard Dawe" <rich AT phekda DOT freeserve DOT co DOT uk>
Message-Id: <2427-Sun31Dec2000115122+0200-eliz@is.elta.co.il>
X-Mailer: Emacs 20.6 (via feedmail 8.3.emacs20_6 I) and Blat ver 1.8.6
CC: djgpp-workers AT delorie DOT com
In-reply-to: <E14CRhO-0006zo-00@phekda.freeserve.co.uk>
(rich AT phekda DOT freeserve DOT co DOT uk)
Subject: Re: Patch to add 'contributing...' section of KB - version 2
References: <E14CRhO-0006zo-00 AT phekda DOT freeserve DOT co DOT uk>
Reply-To: djgpp-workers AT delorie DOT com
Errors-To: nobody AT delorie DOT com
X-Mailing-List: djgpp-workers AT delorie DOT com
X-Unsubscribes-To: listserv AT delorie DOT com

> Date: Sat, 30 Dec 2000 19:26:09 +0000
> From: "Richard Dawe" <rich AT phekda DOT freeserve DOT co DOT uk>
> 
> Here's version 2 of the patch to add the start of a 'contributing to
> DJGPP' section to the knowledge base.

Thanks!

> + * Contributing::        How to contribute to DJGPP.

The node and section name should probably be changed to something more
appropriate.  You are describing the DJGPP coding and documentation
standards, right?

> + @itemize
> + @item
> + Use two spaces after every period/full-stop ending a sentence.

The text you wrote doesn't seem to follow this advice ;-).

> + @item
> + Don't use capital letters for emphasis --- use @samp{@@strong@{@}} instead.

Please remove the white space around "---".

> + @item
> + Don't put a newline between a function's return type and its name.

I think this needs an example; otherwise people will not understand
what are you talking about.

- Raw text -


  webmaster     delorie software   privacy  
  Copyright © 2019   by DJ Delorie     Updated Jul 2019