From sources-request at octave dot org Thu Jun 17 09:58:03 2004
Subject: Patch for documentation
From: "John W. Eaton" <jwe at bevo dot che dot wisc dot edu>
To: Federico Zenith <zenith at chemeng dot ntnu dot no>
Cc: sources at octave dot org
Date: Thu, 17 Jun 2004 09:56:18 -0500

On 17-Jun-2004, Federico Zenith <zenith at chemeng dot ntnu dot no> wrote:

| I already asked some questions underway in other mailing lists, so some of you 
| may already know what I have been doing.
| 
| I began noticing some annoying mistakes in Octave's documentation, which was a 
| pity since it is such a good one. Especially, I wanted to fix the appearance 
| of H-infinity in TeX, which is supposed to be done in a calligraphic style.
| Then, I noticed some non-grouped system flowsheets, some mistakes here and 
| there, and some other nuisances--Well, why not fix that too.
| 
| I ended up putting about a week's time in this patch, which I hope will be 
| useful. It is meant to be applied on Octave version 2.1.57.
| Many function's documentation has been corrected, sometime almost rewritten, 
| many nuisances removed. In one case I modified a function, vander(), as its 
| definition seemingly followed a less common standard.
| And yes, H-infinity and H-2 do look better now.
| 
| The patched sources compile on my machine, and the result seems to be fine.
| 
| Problems to be addressed:
| - - it seems that Octave follows a varargin-like structure, but in its 
| documentation a previous, deprecated system is described, with va_arg and 
| such. Since I don't know how the system has been changed, I could not fix 
| this.
| - - function hinfsyn_ric and lqg have pretty ugly documentation, but since I did 
| not understand their notation 100% I did not modify them radically.

Can you please split up your patch into smaller pieces, each of which
addresses a particular problem?  Otherwise, I'm likely to ignore it
since it is large and I have limited time at the moment to try to
extract the parts that we might want to keep.  If each patch is
smaller and solves just one problem, then it will be much easier to
evalute.  Please post the smaller patches to the bugs list.  The
sources list is for new code contributions, not patches.

For any changes to code, please include ChangeLog entries.

Thanks,

jwe