#10077: Improve doc about coding conventions
-------------------------------+--------------------------------------------
Reporter: jpflori | Owner: mvngu
Type: enhancement | Status: needs_review
Priority: trivial | Milestone: sage-4.6
Component: documentation | Keywords: documentation, coding convention
Author: Minh Van Nguyen | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-------------------------------+--------------------------------------------
Changes (by newvalueoldvalue):
* priority: minor => trivial
* status: new => needs_review
* milestone: => sage-4.6
* author: => Minh Van Nguyen
Comment:
> There is a problem within
http://www.sagemath.org/doc/developer/conventions.html. It says to use "..
NOTE::" and there is "NOTES:" in the example.
Fixed in the attached patch.
[[BR]][[BR]]
> There is also nothing about "TESTS:" section which is often used whithin
the source code.
Fixed in the attached patch.
[[BR]][[BR]]
> The recurrent use of ".. blah ::", "::" and "sage: " could also be
documented
Fixed in the attached patch.
[[BR]][[BR]]
> or at least directly point to the corresponding pages of Sphynx doc
Fixed in the attached patch.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10077#comment:1>
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.
