octave-maintainers
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [OctDev] listing functions in a package


From: John W. Eaton
Subject: Re: [OctDev] listing functions in a package
Date: Tue, 19 Feb 2008 19:59:01 -0500

On 19-Feb-2008, c. wrote:

| 
| On 19/feb/08, at 18:40, John W. Eaton wrote:
| 
| > Makeinfo will format the above as
| >
| > [...] the function is available elsewhere, you can use:
| >      fn = workaround description
| >    This workaround description will not appear when listing [...]
| >
| > To format it properly, you should write
| >
| >   ponting out that  the function is available elsewhere, you can use:
| >
| >   @example
| >   fn = workaround description
| >   @end example
| >
| >   @noindent
| >   This workaround description will not appear when listing  
| > functions in the
| >
| >
| > | +E.g.,
| >
| > Please write "For example," instead of "E.g.".
| >
| > Thanks,
| >
| > jwe
| 
| 
| Done in the attached changeset.

I applied this changeset and also added newlines before the @example
tag.  The @example/@end example environment needs to be set off by
blank lines (before and after), otherwise the Info output produced by
makeinfo doesn't look right.

jwe


reply via email to

[Prev in Thread] Current Thread [Next in Thread]