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.

Sign up for GitHub

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

Jump to bottom

Documentation of private and protected methods #31

Closed
dvdblk opened this issue May 22, 2023 · 5 comments
Closed

Documentation of private and protected methods #31

dvdblk opened this issue May 22, 2023 · 5 comments
Labels
🚀 enhancement New feature or request 🎉 fix released This issue has been addressed in the latest release 👋 response needed Awaiting for a response from a reporter

Comments

@dvdblk
Copy link

dvdblk commented May 22, 2023

Is your feature request related to a problem? Please describe.
I'm trying to create a documentation for a bunch of python code (not a pypi package) and I would like to see the documentation for protected and private methods too. I'm wondering if this is something you would like to support in the future?

Describe the solution you'd like
Private and protected method documentation should be visible in the generated docs.

Describe alternatives you've considered
Changing methods to public.

Additional context
None :)
@dvdblk dvdblk added the 🚀 enhancement New feature or request label May 22, 2023
@vemel
Copy link
Owner

vemel commented Nov 14, 2023

I am going to add support for private and protected methods. I will add a new CLI flag for this.

@yurii-vasylkiv
Copy link

yurii-vasylkiv commented Dec 30, 2023 •
edited
Loading

any updates? coz that is also my issue

thank you

@vemel
Copy link
Owner

vemel commented Jan 2, 2024

@yurii-vasylkiv yes. Already pushed changes to main. Expect a new release today or tomorrow.

@vemel
Copy link
Owner

vemel commented Jan 2, 2024 •
edited
Loading

Documented private and protected methods are added to docs starting from version 2.1.0. Please update and let me know if it works as expected.

@vemel vemel added 🎉 fix released This issue has been addressed in the latest release 👋 response needed Awaiting for a response from a reporter labels Jan 2, 2024
@vemel vemel closed this as completed Jan 10, 2024
@yurii-vasylkiv
Copy link

Documented private and protected methods are added to docs starting from version 2.1.0. Please update and let me know if it works as expected.

Fantastic!!! Thank you so much !!! Your utility is saving me tons of time!!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🚀 enhancement New feature or request 🎉 fix released This issue has been addressed in the latest release 👋 response needed Awaiting for a response from a reporter
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@vemel @dvdblk @yurii-vasylkiv