When consulting the documentation, many code fragments
have annotations that are meant as doctesting instructions.

Among these doctesting instructions, there is one, "# not tested",
that tells the doctesting mechanism to skip that line in doctests.

However, to the non-expert eye, such as a non-developer user
reading the documentation, seeing "# not tested" produces the
impression that this piece of code is not guaranteed to work,
because it has never been tested.

I would like to make a suggestion to make the comments more
explicit, by replacing them as follows:

-     # not tested
+     # doctest: skip

-     # not tested (random order)
+     # doctest: skip (random order)

-     # optional - qepcad
+     # doctest: optional - qepcad

etc.

-- 
You received this message because you are subscribed to the Google Groups 
"sage-devel" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sage-devel+unsubscr...@googlegroups.com.
To post to this group, send email to sage-devel@googlegroups.com.
Visit this group at http://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.

Reply via email to