Opened 10 years ago
Closed 7 years ago
#12844 closed enhancement (fixed)
Update documentation in sage/plot/plot3d/shapes2.py and shapes.pyx
Reported by:  mjo  Owned by:  mvngu 

Priority:  major  Milestone:  sage6.4 
Component:  documentation  Keywords:  plot3d 
Cc:  Merged in:  
Authors:  Frédéric Chapoton  Reviewers:  Ralf Stephan 
Report Upstream:  N/A  Work issues:  
Branch:  64e0a05 (Commits, GitHub, GitLab)  Commit:  64e0a054a2e695653bcc46852627dee26caa479d 
Dependencies:  Stopgaps: 
Description
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 inBox
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)))
Change History (11)
comment:1 Changed 8 years ago by
 Milestone changed from sage5.11 to sage5.12
comment:2 Changed 8 years ago by
 Milestone changed from sage6.1 to sage6.2
comment:3 Changed 8 years ago by
 Milestone changed from sage6.2 to sage6.3
comment:4 Changed 7 years ago by
 Branch set to u/chapoton/12844
 Commit set to 300b594d8234e5cb59139ad1702901e12b612913
 Keywords plot3d added
 Status changed from new to needs_review
comment:5 Changed 7 years ago by
 Status changed from needs_review to needs_work
Here is a branch.
There remains only to be more precise about the color
parameter.
comment:6 Changed 7 years ago by
 Commit changed from 300b594d8234e5cb59139ad1702901e12b612913 to 48f691a74ca6b10c5f31bd3db90dd61cde8658f0
comment:7 Changed 7 years ago by
 Status changed from needs_work to needs_review
comment:8 Changed 7 years ago by
 Branch changed from u/chapoton/12844 to u/rws/12844
comment:9 Changed 7 years ago by
 Commit changed from 48f691a74ca6b10c5f31bd3db90dd61cde8658f0 to 64e0a054a2e695653bcc46852627dee26caa479d
 Reviewers set to Ralf Stephan
 Status changed from needs_review to positive_review
Had to fix compilation at some points. Also "i.e." (id est) demands comma after it.
New commits:
64e0a05  12844 reviewer's patch: fix doc compile, typo

comment:10 Changed 7 years ago by
 Milestone changed from sage6.3 to sage6.4
comment:11 Changed 7 years ago by
 Branch changed from u/rws/12844 to 64e0a054a2e695653bcc46852627dee26caa479d
 Resolution set to fixed
 Status changed from positive_review to closed
Note: See
TracTickets for help on using
tickets.
New commits:
trac #12844 cleanup of doc in plot3d