Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for rendering methods section of docstring (or explicit error) #306

Open
machow opened this issue Nov 20, 2023 · 0 comments
Open
Labels
type:bug Something isn't working

Comments

@machow
Copy link
Owner

machow commented Nov 20, 2023

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:

image

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:

NotImplementedError: Unsupported type: <class 'griffe.docstrings.dataclasses.DocstringSectionFunctions'>

At the very least, we should make this message clearer (or issue a warning instead).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:bug Something isn't working
Projects
Status: No status
Development

No branches or pull requests

1 participant