8000 docs: Document lack of support for Numpydoc Methods sections · Thomzoy/python@37a6000 · GitHub
[go: up one dir, main page]

Skip to content

Commit 37a6000

Browse files
pawamoyMaximiliano Greco
and
Maximiliano Greco
committed
docs: Document lack of support for Numpydoc Methods sections
Co-authored-by: Maximiliano Greco <mmngreco@users.noreply.github.com>
1 parent 30bcf33 commit 37a6000

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/usage.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,12 @@ both globally or per autodoc instruction.
8888

8989
See the supported docstring sections on [Griffe's documentation](https://mkdocstrings.github.io/griffe/docstrings/).
9090

91+
!!! note
92+
As Numpy-style is partially supported by the underlying parser,
93+
you may experience problems in the building process if your docstring
94+
has a `Methods` section in the class docstring
95+
(see [#366](https://github.com/mkdocstrings/mkdocstrings/issues/366)).
96+
9197
#### Google-style admonitions
9298

9399
With Google-style docstrings, any section that is not recognized will be transformed into its admonition equivalent.

0 commit comments

Comments
 (0)
0