#10077: Improve doc about coding conventions.
-----------------------------+----------------------------------------------
Reporter: jpflori | Owner: mvngu
Type: enhancement | Status: new
Priority: minor | Milestone:
Component: documentation | Keywords: documentation, coding convention
Author: | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
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.
There is also nothing about "TESTS:" section which is often used whithin
the source code.
The recurrent use of ".. blah ::", "::" and "sage: " could also be
documented or at least directly point to the corresponding pages of Sphynx
doc (even if looking at the examples is of course the best way to go and
looking through Sphynx doc also explains many things).
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10077>
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.
