search

pdoc3 / pdoc

:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
https://pdoc3.github.io/pdoc/
GNU Affero General Public License v3.0
1.12k stars 145 forks source link

Filter out "dummy" when listing for class content #309

Closed pums974 closed 3 years ago

pums974 commented 3 years ago

In the module page, the hidden inherited methods appears as "dummy" class variable: image

The proposed patch, simply removes them: image

kernc commented 3 years ago

Huh? Where does this come from? :flushed:

The only place we're setting "dummy" is in the test your patch fails: https://github.com/pdoc3/pdoc/blob/49b7773ba6a96ddee63bf5c4cd48df250ab12c36/pdoc/test/__init__.py#L940-L945

pums974 commented 3 years ago

No there is also line 706 https://github.com/pdoc3/pdoc/blob/4b94c42838f2dbcb043ce8382be310c682623aaa/pdoc/__init__.py#L704-L708 and line 1050 https://github.com/pdoc3/pdoc/blob/4b94c42838f2dbcb043ce8382be310c682623aaa/pdoc/__init__.py#L1048-L1052

In my case it's the second one that shows up

kernc commented 3 years ago

@pums974 Is there a simple test case we can include/extend as a regression test for this issue?

pums974 commented 3 years ago

I don't know, probably.

But I'm really not an expert on this, and I have to admit that I have trouble understanding your tests.