You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, we do not support the rendering of a custom methods section in a numpydoc style docstring. Here is its description in the numpydoc spec:
It seems like--similar to the attributes section--the methods section often conflicts with just documenting the methods themselves. For example, quartodoc can summarize your methods using their docstrings.
Currently, including a methods section raises an error during rendering:
Currently, we do not support the rendering of a custom methods section in a numpydoc style docstring. Here is its description in the numpydoc spec:
It seems like--similar to the attributes section--the methods section often conflicts with just documenting the methods themselves. For example, quartodoc can summarize your methods using their docstrings.
Currently, including a methods section raises an error during rendering:
At the very least, we should make this message clearer (or issue a warning instead).
The text was updated successfully, but these errors were encountered: