#11698: Fix trivial typo in Sage devel guide
------------------------------+---------------------------------------------
   Reporter:  kcrisman        |          Owner:  mvngu                          
    
       Type:  defect          |         Status:  needs_review                   
    
   Priority:  trivial         |      Milestone:  sage-4.7.2                     
    
  Component:  documentation   |       Keywords:                                 
    
Work_issues:                  |       Upstream:  N/A                            
    
   Reviewer:  Leif Leonhardy  |         Author:  Karl-Dieter Crisman, Jeroen 
Demeyer
     Merged:                  |   Dependencies:                                 
    
------------------------------+---------------------------------------------
Changes (by newvalueoldvalue):

  * author:  Karl-Dieter Crisman => Karl-Dieter Crisman, Jeroen Demeyer


Old description:

> In the [http://www.sagemath.org/doc/developer/sage_manuals.html#building
> part about docbuilding], there is a small typo.
> {{{
> as explained below. Use the following command to obtain more
> documentation for the sage -docbuild script:
>
> sage -docbuild -help
> }}}
> should have either `--help`, `-h`, or `--help-all` (the latter does
> something different, though still useful - maybe both should be
> documented).  The current thing does the same as `-h` but gives a Sphinx
> warning about the unknown option `e`.

New description:

 In the [http://www.sagemath.org/doc/developer/sage_manuals.html#building
 part about docbuilding], there is a small typo.
 {{{
 as explained below. Use the following command to obtain more documentation
 for the sage -docbuild script:

 sage -docbuild -help
 }}}
 should have either `--help`, `-h`, or `--help-all` (the latter does
 something different, though still useful - maybe both should be
 documented).  The current thing does the same as `-h` but gives a Sphinx
 warning about the unknown option `e`.

 '''Apply''' [attachment:11698_v2.patch]

--

Comment:

 I made some of the easy changes mentioned above. Karl-Dieter, could you
 review my patch? It is based on your patch but replaces it.

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11698#comment:11>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica, 
and MATLAB

-- 
You received this message because you are subscribed to the Google Groups 
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/sage-trac?hl=en.

Reply via email to