Skip to content

Commit

Permalink
src/doc/en/developer/doctesting.rst: Document more sage --fixdoctest …
Browse files Browse the repository at this point in the history
…options
  • Loading branch information
Matthias Koeppe committed Sep 14, 2023
1 parent 3dd5288 commit d603403
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/doc/en/developer/doctesting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1633,6 +1633,9 @@ To have the doctest fixer take care of the ``# optional/needs`` tags,
but not change the expected results of examples, use the option ``--only-tags``.
This mode is suitable for mostly unattended runs on many files.

With the option ``--verbose``, the doctest fixer shows the doctester's messages
one by one and reports the changes made.

.. warning::

While the doctest fixer guarantees to preserve any comments that
Expand Down Expand Up @@ -1675,6 +1678,12 @@ to the doctest.
Likewise, when the doctester runs into a :class:`ModuleNotFoundError`,
the doctest fixer will automatically add a ``# needs ...`` tag.

The switch ``--distribution`` can be repeated; the given distributions
will be tested in sequence. Using ``--distribution all`` is equivalent
to a preset list of ``--distribution`` switches. With the switch
``--fixed-point``, the doctest fixer runs the given distributions until
no more changes are made.


Updating baseline files
-----------------------
Expand Down

0 comments on commit d603403

Please sign in to comment.