#12844: Update documentation in sage/plot/plot3d/shapes2.py and shapes.pyx
-----------------------------+----------------------------------------------
   Reporter:  mjo            |             Owner:  mvngu   
       Type:  enhancement    |            Status:  new     
   Priority:  major          |         Milestone:  sage-5.0
  Component:  documentation  |          Keywords:          
Work issues:                 |   Report Upstream:  N/A     
  Reviewers:                 |           Authors:          
  Merged in:                 |      Dependencies:          
   Stopgaps:                 |  
-----------------------------+----------------------------------------------
 Continued from #12620, there are still issues with the documentation of
 shapes.pyx and shapes2.py. Some examples:

  * Many functions take a `color` argument with the description,

    {{{
    -  ``color`` - a word that describes a color`
    }}}

  which is inaccurate.

  * The `A square black box:` example in `Box` is not black.

  * Some doctests are misformatted, e.g.

    {{{
    EXAMPLES:
         sage: from sage.plot.plot3d.shapes import Box
    }}}

  * `Torus` is missing a docstring:

    {{{
    cdef class Torus(ParametricSurface):
    # e.g  show(sum([Torus(1,.03,20,20, color=[1, float(t/30),
 0]).rotate((1,1,1),t) for t in range(30)], Sphere(.3)))
    }}}

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/12844>
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