delorie.com/archives/browse.cgi   search  
Mail Archives: djgpp-workers/2003/03/31/15:39:38

Date: Mon, 31 Mar 2003 23:30:03 +0200
From: "Eli Zaretskii" <eliz AT elta DOT co DOT il>
Sender: halo1 AT zahav DOT net DOT il
To: rich AT phekda DOT freeserve DOT co DOT uk
Message-Id: <2427-Mon31Mar2003233003+0300-eliz@elta.co.il>
X-Mailer: emacs 21.3.50 (via feedmail 8 I) and Blat ver 1.8.9
CC: djgpp-workers AT delorie DOT com
In-reply-to: <E1903IP-00031B-00@phekda.freeserve.co.uk>
(rich AT phekda DOT freeserve DOT co DOT uk)
Subject: Re: Documentation fixes: @ref, @var{errno} [PATCH]
References: <E1903IP-00031B-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: Mon, 31 Mar 2003 18:45:51 +0100
> From: "Richard Dawe" <rich AT phekda DOT freeserve DOT co DOT uk>
> 
> Below is a patch to fix a couple of documentation issues:
> 
> * Some uses of @ref do not have a comma or full-stop (period)
>   after them. I've used @pxref in most cases.
> 
> * When describing what a function sets the error code to,
>   @var{errno} is incorrect. It should be @code{errno}.
> 
> OK to commit?

Yes, but please correct this minor glitch:

> ! functions (@pxref{dosmemget}, @pxref{dosmemput}) or any one of the far

It is not a good idea to use more than a single @pxref inside the same
paren, since @pxref produces a period after the reference, so you will
have a ".," in the Info output, which looks like a typo.

This is better:

 functions (see @ref{dosmemget}, and @pxref{dosmemput}) or any one of the far

Thanks!

- Raw text -


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