#5767: [with patch; needs review] Bring coverage of plot3d/base.pyx up to 87%
----------------------+-----------------------------------------------------
 Reporter:  robertwb  |       Owner:  mabshoff
     Type:  defect    |      Status:  new     
 Priority:  major     |   Milestone:  sage-4.0
Component:  doctest   |    Keywords:          
----------------------+-----------------------------------------------------

Comment(by robertwb):

 Thanks for looking into this.

 Replying to [comment:4 wcauchois]:
 > REFEREE REPORT
 >
 > Excellent work Robert! This patch applies to Sage 3.4.1 and the doctests
 are all valid. There were a number of misspellings which I corrected in
 5767-referee.patch (I'm sorry I accidentally attached it twice; use either
 one). Besides that, I have a few concerns:
 >
 >  * It looks like there are some typos due to copy-and-pasing:
 >    * On line 446 the documentation for tachyon() says it returns "an x3d
 input file".
 >    * On line 1202 the documentation for obj_repr() says it returns "the
 x3d representation of a group".
 >    * On line 1230 the documentation for jmol_repr() says it returns "the
 x3d representation of a group".

 Fixed.

 >  * The documentation for jmol_repr on line 657 is somewhat confusing for
 me, especially when you say that jmol uses the strings to "construct
 self". Could you replace that with something like "construct a 3D mesh
 representing this object"? The same concern applies to the documentation
 for tachyon_repr and obj_repr.

 I clarified it.

 >  * Do you think it would improve the readability of the documentation to
 replace "self" with "!`self!`" -- that is, to apply preformatting to it?

 I'm not sure it's worth it.

 >  * What's up with the trailing spaces on every line?

 Sorry, I attached another patch that removes this (but I'm not sure if
 it'll apply cleanly, if not it's probably not worth it).

 >  * On line 730 you use the word "preable". Is this a typo?

 Yep, I meant preamble. Fixed.

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/5767#comment:10>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of 
Reinventing the Wheel

--~--~---------~--~----~------------~-------~--~----~
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