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

have the auto generated doc include private methods #184

Open
mkinney opened this issue Dec 29, 2021 · 1 comment
Open

have the auto generated doc include private methods #184

mkinney opened this issue Dec 29, 2021 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@mkinney
Copy link
Contributor

mkinney commented Dec 29, 2021

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
Copy link
Contributor Author

mkinney commented Dec 29, 2021

Opened issue about this: pdoc3/pdoc#375

@garthvh garthvh added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Mar 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants