#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 novoselt):
I a bit disagree with the interpretation of "TESTS" directive. I tend to
put there any tests that do not really help in illustrating the function.
For example, if there was a bug detected on some valid but long and
perhaps obscure input, I think that it should go to TESTS. On the other
hand, if some exceptions are not unusual, they may very well be
illustrated in EXAMPLES, e.g. solving an overdetermined system of
equations. Personally, I think that EXAMPLES are bits of code that show
how to use a function. Bits of code that make sure that every branch of
code got executed can be much more numerous than necessary for
illustration.
What's the point of "notes" in lower case? Is it really necessary for
something or maybe it is possible to list only `.. NOTES::`?
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10077#comment:2>
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.
