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

missing docstrings of methods #426

Open
emanueleromito opened this issue Jul 5, 2023 · 2 comments
Open

missing docstrings of methods #426

emanueleromito opened this issue Jul 5, 2023 · 2 comments

Comments

@emanueleromito
Copy link

emanueleromito commented Jul 5, 2023

Hi guys. Thanks for releasing and mantaining pdoc.

In my codebase, I have a class that inherits from an abstract class, and within this derived class, I have methods named "compute" that are decorated or modified by a wrapper. However, when generating the HTML documentation using pdoc, I noticed that the docstrings associated with these "compute" methods are missing in the generated documentation.

I have verified that the docstrings are present in the source code and are correctly formatted. However, they are not appearing in the generated HTML documentation. This issue seems to be specific to the "compute" methods within the derived class, as the docstrings for other methods are being displayed correctly.

@misanthropicat
Copy link

Have the same problem: any decorated method of any class inherited from abstract object has missing docstrings in generated HTML documentation. Any plans to fix it?

@thatdc-reply
Copy link

I am having the same issue: any method decorated with @ is omitted in the documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants