Skip to content

Commit c410820

Browse files
committed
Warn about numpy#130
1 parent 810ddd8 commit c410820

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/format.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -373,6 +373,12 @@ The sections of the docstring are:
373373
should not be required to understand it. References are numbered, starting
374374
from one, in the order in which they are cited.
375375

376+
.. warning:: **References will break tables**
377+
378+
Where references like [1] appear in a tables within a numpydoc
379+
docstring, the table markup will be broken by numpydoc processing. See
380+
`numpydoc issue #130 <https://github.com/numpy/numpydoc/issues/130>`_
381+
376382
12. **Examples**
377383

378384
An optional section for examples, using the `doctest

0 commit comments

Comments
 (0)