#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: |
-------------------------------+--------------------------------------------
Comment(by jpflori):
Thanks a lot for the patch.
I guess with it the situation for newcomers as myself will be much
clearer.
I kind of agree with novoselt statement about what EXAMPLES and TESTS
blocks should be used for, but don't know what was decided by Sage devs
because of the lack of doc before what you just produced.
About the "notes" and "warning" in lower case, they could maybe be
mentionned but their use strongly discouraged (e.g. "you'll also find a
lot of ".. notes::" in existing source code, which is valid, but the use
of the lower case version is strongly discouraged", or "we are currently
in the process of converting everything to uppercase").
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10077#comment:3>
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.
