delorie.com/archives/browse.cgi   search  
Mail Archives: djgpp-workers/2000/09/04/06:38:14

From: Martin Stromberg <Martin DOT Stromberg AT lu DOT erisoft DOT se>
Message-Id: <200009041037.MAA03506@lws256.lu.erisoft.se>
Subject: Re: Doc for __dosexec_find_on_path()
To: djgpp-workers AT delorie DOT com
Date: Mon, 4 Sep 2000 12:37:49 +0200 (MET DST)
In-Reply-To: <Pine.SUN.3.91.1000903081819.24880H-100000@is> from "Eli Zaretskii" at Sep 03, 2000 08:39:44 AM
X-Mailer: ELM [version 2.5 PL3]
MIME-Version: 1.0
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

Eli said:
> There's no automatic line breaks inside @example.  So breaking long lines 
> by hand is a Good Thing.
> 
> In fact, most of the library's .txh files need to be fixed like that: 
> many Description sections overflow the page margins when a printable 
> version of the reference is produced.  I think that every @example in the 
> Description section should be replaced with @smallexample (with a 
> suitable change to "@end example"), and then the lines which are longer 
> than 60 characters should be broken into multiple lines.
> 
> So I'd like to ask everybody who changes or adds documentation to please 
> take care of this issue as well.

I'm not sure I understand. 

1. @example -> @smallexample

2. break lines at 60 characters

Should we do 1 or 2 or (1 and 2)?


Right,

						MartinS

- Raw text -


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