GitHub - lagru/docstring-plot-bug-demo: Demonstration of a bug with including plots in docstrings with numpydoc

This repository was archived by the owner on Sep 25, 2019. It is now read-only.

lagru / docstring-plot-bug-demo Public archive

Notifications You must be signed in to change notification settings
Fork 0
Star 0

Demonstration of a bug with including plots in docstrings with numpydoc

Notifications

Name		Name	Last commit message	Last commit date
Latest commit History 3 Commits
Makefile		Makefile
README.txt		README.txt
conf.py		conf.py
demo_module.py		demo_module.py
index.rst		index.rst
make.bat		make.bat
requirements.txt		requirements.txt

Repository files navigation

Demo
====

Run `make html` in this directory. The output should contain the following
error message:

```
/**/demo_module.py:docstring of demo_module.bar:22: WARNING: Exception occurred in plotting index-1 from /**/index.rst:
Traceback (most recent call last):
  File "/**/site-packages/matplotlib/sphinxext/plot_directive.py", line 524, in run_code
    six.exec_(code, ns)
  File "<string>", line 2
    but end the docstring with a text line right after invoking `plt.show()` the
          ^
SyntaxError: invalid syntax
```

Open the file `_build/html/index.html` and compare how the docstrings of the
two functions are rendered. One doesn't contain the expected plot!