[PATCH] A Few (Small) Documentation Fixes

Hey Robert,

On 11/28/2012 12:17 PM, Robert Dodier wrote:
> Hi Kris, thanks for your help.
> 

No problem.

> On 2012-11-27, Kris Katterjohn <katterjohn at gmail.com> wrote:
> 
>> ? minimize_lp: Typo: "Ploblem" -> "Problem"
>>
>> ? to_poly: Change "%g6" -> "%g130" to match the example.  I guess the example
>> was updated at some point without changing these references.
> 
> OK. I've applied these 2 changes and they'll appear in the next release.
> 
>> ? %phi: Several sentences were duplicated.  I chose to keep the second copies
>> (since they were with examples) and I moved the @mref from the first copies to
>> replace the corresponding @code in the second.  I think this is right (and the
>> patch is probably easier to understand now).
> 
> Well, the duplication is deliberate. First there is a statement in the
> exposition, then it is recapitulated in the examples. If it appears only
> in the examples, the user must read the whole entry to get all the
> information, and in the examples, they can't tell what's intended as
> additional info and what is just a clarification, and they can't tell
> what else might have been omitted from the exposition.
> 

Fair enough, I can see your point.

It just looks rather funny to me having verbatim copies so close to one
another when the examples just illustrate precisely what the text is referring
to.  I was simply thinking of descriptions which interlace text and examples
(e.g., to_poly).  Thinking about it again now, perhaps my patch should have
(essentially) just removed the text "Examples:" as well.

>> The patch is against the doc/info/*.texi files.  As with a previous doc patch
>> I submitted, I don't know if the other languages are automated somehow or if
>> they are translated and updated manually.  I assume that just updating the
>> .texi files is sufficient.
> 
> The translations are updated by hand. It's enough to update the English
> version, then the translators will notice and update the translations.
> 

OK, cool.

> best,
> 
> Robert Dodier
> 

Cheers,
Kris Katterjohn