#10078: Change ".. warning::" to ".. WARNING::"
-----------------------------+----------------------------------------------
Reporter: jpflori | Owner: mvngu
Type: enhancement | Status: needs_info
Priority: trivial | Milestone: sage-4.6
Component: documentation | Keywords: documentation
Author: | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
Comment(by mvngu):
Replying to [comment:3 mhansen]:
> Wait, why is this the case? All of the Sphinx directives are generally
lower case.
I'm the guilty person who encourages the use of "WARNING". That's because
I consider it to be a section title, just as "INPUT" is the title of the
section for input, "OUTPUT" the title for the section on output,
"EXAMPLES" for the title of the section on example usage, etc. I have been
very careful in my use of words when I edited the
[http://www.sagemath.org/doc/developer/conventions.html#docstring-markup-
with-rest-and-sphinx documentation conventions] in the Developer's Guide.
I encourage the use of the upper-case form because Sphinx can parse both
the lower- and upper-case versions, while refraining from saying that the
upper-case version is the only acceptable usage. I'm rather ambivalent
about this ticket. On the one hand, I think the upper-case form encourages
consistency. On the other hand, implementing the topic of this ticket can
cause some (or even a lot of) bad feeling in many people.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10078#comment:4>
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.
