Skip to content

Commit

Permalink
Merge pull request #190 from bsipocz/doc_add_doctest-skip-all
Browse files Browse the repository at this point in the history
DOC: adding doctest-skip-all
  • Loading branch information
pllim authored Oct 5, 2022
2 parents 5710a7c + f463e25 commit 2c4c5ca
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.rst
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

0 comments on commit 2c4c5ca

Please sign in to comment.