Skip to content

Commit

Permalink
DOC: Update refguide_check note on how to skip code
Browse files Browse the repository at this point in the history
  • Loading branch information
sethtroisi committed Jan 28, 2020
1 parent 7b71975 commit d20378b
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions tools/refguide_check.py
Original file line number Diff line number Diff line change
Expand Up @@ -947,6 +947,14 @@ def check_doctests_testfile(fname, verbose, ns=None,
Notes
-----
refguide can be signalled to skip testing code by adding
``#doctest: +SKIP`` to the end of the line. If the output varies or is
random, add ``# may vary`` or ``# random`` to the comment. for example
>>> plt.plot(...) # doctest: +SKIP
>>> random.randint(0,10)
5 # random
We also try to weed out pseudocode:
* We maintain a list of exceptions which signal pseudocode,
* We split the text file into "blocks" of code separated by empty lines
Expand Down

0 comments on commit d20378b

Please sign in to comment.