Charles,
> Skimming over the reference manual, it seems that there is no clear
> standard regarding how to write some things. For instance, sometimes self
> is double-quoted (``self``), sometimes it isn't. Sometimes True and False
> are double-quoted, sometimes not. Sometimes the name of arguments
> (say, x) is single-quoted (when they are mathematical variables),
> sometimes they are double-quoted, and sometimes they are not quoted at
> all, etc. etc. etc.
>
> What is the preferred way to go?
For name of variables, functions, ..., you must use two backquotes
because this is the standard in Shinpx
(http://sphinx-doc.org/rest.html) and Docutils
(http://docutils.sourceforge.net/docs/ref/rst/roles.html#literal).
The single backqoute must be used only for math elements that will be
rendering using LaTeX
(http://docutils.sourceforge.net/docs/ref/rst/roles.html#math).
> Also, to describe what a function does, is it better to write maths in latex
> (i.e., if `x = 0`) or in "sage code" (i.e., if ``x == 0``) ?
It will depend if you use the sign symbol (=) to mean attribution or
not when describe what the algorithm does. Once in "sage code" (and
python) the sign symbol mean attribution I prefer to use the two sign
symbol to mean comparison (``x == 0``).
Raniere
--
You received this message because you are subscribed to the Google Groups
"sage-devel" group.
To post to this group, send email to sage-devel@googlegroups.com.
To unsubscribe from this group, send email to
sage-devel+unsubscr...@googlegroups.com.
Visit this group at http://groups.google.com/group/sage-devel?hl=en.
