python icon indicating copy to clipboard operation
python copied to clipboard

have the auto generated doc include private methods

Open mkinney opened this issue 3 years ago • 2 comments

Looks like the pdoc tool will not generate methods/variables that start with an underscore, as that is the pythonic way to specify "private".

Beings that Meshtastic-python is a dev library, that is not very helpful.

I've narrowed it down to this line: https://github.com/mkinney/pdoc/blob/master/pdoc/init.py#L409

I've changed it to this:

return not ident_name.startswith("__")

Now our doc includes more of what we want. I need to see if I can pass a command line arg to pdoc or add a config setting or something.

mkinney avatar Dec 29 '21 06:12 mkinney

Opened issue about this: https://github.com/pdoc3/pdoc/issues/375

mkinney avatar Dec 29 '21 06:12 mkinney