Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: adding doctest-skip-all #190

Merged
merged 1 commit into from
Oct 5, 2022
Merged

DOC: adding doctest-skip-all #190

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,22 @@ directive
However, it is often useful to be able to skip docstrings associated with
particular functions, methods, classes, or even entire files.

Skipping All the Tests
^^^^^^^^^^^^^^^^^^^^^^

It is also possible to skip all doctests below a certain line using
a ``doctest-skip-all`` comment. Note the lack of ``::`` at the end
of the line here.

.. code-block:: rst

.. doctest-skip-all

>>> import non_existing
>>> non_existing.write_pseudo_code()
All the doctests are skipped in the file below


Skip Unconditionally
^^^^^^^^^^^^^^^^^^^^

Expand Down