Skip to content

Commit 7ee014b

Browse files
pawamoymmngreco
andcommitted
docs: Document lack of support for Numpydoc Methods sections
Co-authored-by: Maximiliano Greco <mmngreco@users.noreply.github.com>
1 parent a3621b2 commit 7ee014b

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

docs/usage.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,12 @@ Type annotations are read both in the code and in the docstrings.
224224
# etc.
225225
```
226226

227+
!!! note
228+
As Numpy-style is partially supported by the underlying parser,
229+
you may experience problems in the building process if your docstring
230+
has a `Methods` section in the class docstring
231+
(see [#366](https://github.com/mkdocstrings/mkdocstrings/issues/366)).
232+
227233
You can see examples of Numpy-style docstrings
228234
in [numpydoc's documentation](https://numpydoc.readthedocs.io/en/latest/format.html).
229235

0 commit comments

Comments
 (0)