File tree Expand file tree Collapse file tree 1 file changed +9
-0
lines changed Expand file tree Collapse file tree 1 file changed +9
-0
lines changed Original file line number Diff line number Diff line change @@ -567,6 +567,15 @@ doctests that depend on :class:`sage.symbolic.ring.SymbolicRing` for integration
567567testing. Hence, these doctests are marked ``# optional -
568568sage.symbolic ``.
569569
570+ When defining new features for the purpose of doctest annotations, it may be a good
571+ idea to hide implementation details from feature names. For example, all doctests that
572+ use finite fields have to depend on PARI. However, we have defined a feature
573+ :mod: `sage.rings.finite_rings ` (which implies the presence of :mod: `sage.libs.pari `).
574+ Annotating the doctests ``# optional - sage.rings.finite_rings `` expresses the
575+ dependency in a clearer way than using ``# optional - sage.libs.pari ``, and it
576+ will be a smaller maintenance burden when implementation details change.
577+
578+
570579Testing the distribution in virtual environments with tox
571580---------------------------------------------------------
572581
You can’t perform that action at this time.
0 commit comments