pdoc icon indicating copy to clipboard operation
pdoc copied to clipboard

missing docstrings of methods

Open emanueleromito opened this issue 2 years ago • 3 comments

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.

emanueleromito avatar Jul 05 '23 10:07 emanueleromito

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?

misanthropicat avatar Aug 17 '23 06:08 misanthropicat

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

thatdc-reply avatar Feb 21 '24 11:02 thatdc-reply

The behavior is based on this logic: https://github.com/pdoc3/pdoc/blob/d1136eafa45315bf5e89596197a24804e4790ee6/pdoc/init.py#L1045-L1059 https://github.com/pdoc3/pdoc/blob/d1136eafa45315bf5e89596197a24804e4790ee6/pdoc/init.py#L993-L1018 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?

kernc avatar Jun 24 '24 02:06 kernc