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

enable showing private methods/variables #375

Open
mkinney opened this issue Dec 29, 2021 · 2 comments
Open

enable showing private methods/variables #375

mkinney opened this issue Dec 29, 2021 · 2 comments

Comments

@mkinney
Copy link

mkinney commented Dec 29, 2021

Expected Behavior

Would like to see private methods/variables in the documentation

Actual Behavior

Methods and variables that begin with "_" are excluded.

Steps to Reproduce

  1. Generate docs that have a private method.
  2. See that the private method does not show up

Additional info

  • pdoc version: (installed from master) % pdoc --version
    pdoc 0.10.0

If I change this line:
https://github.com/mkinney/pdoc/blob/master/pdoc/__init__.py#L409

to this:

return not ident_name.startswith("__")

It does what I'd like to see.

Would it make sense to add a command line arg (or configuration setting) that would enable this?

@luzpaz
Copy link

luzpaz commented Jul 26, 2023

bump

@luzpaz
Copy link

luzpaz commented Nov 19, 2023

No response ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants