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

Add Visibility Modifiers #578

Merged
merged 2 commits into from
Jun 19, 2023
Merged

Add Visibility Modifiers #578

merged 2 commits into from
Jun 19, 2023

Conversation

mhils
Copy link
Member

@mhils mhils commented Jun 19, 2023

This PR adds two new exciting features:

  1. The ability to add @private to a docstring to exclude the member from documentation.
  2. The ability to pass --no-include-undocumented to exclude all undocumented members.

These changes supplement #575, which enables the documentation of all variables by default.

(cc @rpitasky - this should address #575 (comment))

@mhils mhils merged commit 0dddb3f into mitmproxy:main Jun 19, 2023
12 checks passed
@mhils mhils deleted the visibility-modifiers branch June 19, 2023 11:41
@rpitasky
Copy link

Gorgeous work, I think this really improves pdoc as a whole :)

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

Successfully merging this pull request may close these issues.

2 participants