We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 810ddd8 commit c410820Copy full SHA for c410820
doc/format.rst
@@ -373,6 +373,12 @@ The sections of the docstring are:
373
should not be required to understand it. References are numbered, starting
374
from one, in the order in which they are cited.
375
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
382
12. **Examples**
383
384
An optional section for examples, using the `doctest
0 commit comments