Re: changeset for Manual

[Rik]

> -------- Original Message --------
> Subject:      changeset for Manual
> Date:         Tue, 21 Dec 2010 15:53:24 -0800
> From:         Michael D. Godfrey <address@hidden>
> To:   John W. Eaton <address@hidden>
> 
> 
> 
> John,
> Attached is a changeset which updates the gammainc and legendre
> text in the Manual.  Pretty trivial format changes, but the legendre
> math was in @ifnotex mode and looked nearly unreadable. I left
> the old text in, but enclosed in @ifnotex ... @end ifnotex.
> I think that I did this correctly by updating the docstrings in the files
> gammainc.cc and legendre.m files.  Is this right?  If this works
> OK I will try to do some more updating as I notice problems. 
> 
> I forgot, I just now realize, to include a Changelog entry.  Sorry.
> 
> Actually, I am not clear how to include the Changelog text.
> Hint?
12/26/10

Michael,

I committed your patch here
(http://hg.savannah.gnu.org/hgweb/octave/rev/e7ed20f87e82).

The Changelog entry for documentation follows the same guidelines as for
ordinary changes, i.e., document *what* you did but not a big explanation
on why you did it.  For your changeset I used "Add @tex blocks to
docstring."  If there is more than one unrelated change I often just use
"Improved docstring" rather than reciting a long laundry list of specific
changes such as "Fixed typo trough -> through, ...".  The only exception
here is that I use "overhaul" or "re-write" if very little of the original
docstring remains.  This gives an indication that the edit was major rather
than minor.

Cheers,
Rik