Dear Sage developers,
It's quite common that optional doctests come in batch, typically when
documenting a method that is only available when a certain feature or
package is available. Having to mark each and every test line with
`# optional xxx` is redundant, painful, and harms readability.
At Sage Days 77, we discussed introducing a docstring-wide markup that
would be equivalent to adding # optional on all the following
doctests. It could be nice to have it as a Sphinx markup that we could
possibly highlight nicely (or hide?) in the documentation. Something like::
EXAMPLES::
sage: ...
.. OPTIONAL:: gap3
::
sage: gap3(...)
sage: gap3(...)
Incidentally, this would be very useful for #11187.
I have posted a preliminary implementation on #20427 [1].
Feedback welcome!
In particular: do we want to also have a module-wide markup, typically
when putting the OPTIONAL markup on the module docstring.
Cheers,
Nicolas
http://trac.sagemath.org/ticket/20427
--
Nicolas M. Thiéry "Isil" <[email protected]>
http://Nicolas.Thiery.name/
--
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 [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.
