-
-
Notifications
You must be signed in to change notification settings - Fork 147
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
Labels
Comments
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? |
I am having the same issue: any method decorated with @ is omitted in the documentation |
The behavior is based on this logic: Lines 1045 to 1059 in d1136ea
Lines 993 to 1018 in d1136ea
I don't know if it solves it, but now that inspect.getmembers_static() is available, we should probably see to using that instead of the above custom logic. Can somebody try it?
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The text was updated successfully, but these errors were encountered: