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 classes? #9

Open
jdtsmith opened this issue Oct 11, 2021 · 3 comments
Open

Support classes? #9

jdtsmith opened this issue Oct 11, 2021 · 3 comments
Labels
enhancement New feature or request

Comments

@jdtsmith
Copy link

This looks very nice. I immediately ran into trouble documenting a class, which numpydoc style indicates should contain all normal sections, documenting __init__ parameters, attributes, and (possibly) methods. This would be a great addition. Possibly just __init__ parameters to start and placing a to-be-filled attributes section?

@douglasdavis
Copy link
Owner

douglasdavis commented Oct 12, 2021

I'd welcome any PR that adds support for classes! I can give it a try but there are no guarantees that I'll find any consistent time to work on it in the immediate future.

@douglasdavis douglasdavis added the enhancement New feature or request label Nov 29, 2021
@lu-pl
Copy link

lu-pl commented Jul 10, 2024

Any news on this?

I think an interims solution would be to have docstrings for __init__ inserted as the class definition.

Numpydoc says that for classes all sections but Returns can be used and that "[t]he constructor (init) should also be documented here, the Parameters section of the docstring details the constructor’s parameters.

@douglasdavis
Copy link
Owner

douglasdavis commented Jul 18, 2024

I don't have the bandwidth to work on this, but I'd welcome a PR. Somewhat related: it's on the very bottom of my todo list to investigate using built-in tree-sitter support that landed in Emacs some time ago to improve this package and perhaps make it easier to contribute to.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants