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

Hide non-public class methods from documentation #31

Closed
Meettya opened this issue Jul 19, 2012 · 1 comment
Closed

Hide non-public class methods from documentation #31

Meettya opened this issue Jul 19, 2012 · 1 comment

Comments

@Meettya
Copy link
Contributor

Meettya commented Jul 19, 2012

I suppose it is necessary to implement - hide non-public methods, but can`t to decide how it must be done.

Why its important future - private methods is NOT a public interface and its clutter up documentation with unnecessary details.

For my code I use classical naming notation for 'private' methods - '_methodName' - name started by underscore.

May be add to CLI args something like
--private-method group (by default) - group all non-public methods in one category, placed at the end of class docs
--private-method fold group AND fold methods list, unfolding by click
--private-method hide to wipe out from documentation all private methods

I may try to implement this behavior, so I looks for some help:

  • correct name for CLI key
  • correct name for CLI key options
  • is concept is ok?

PS.Sorry for 'broken English', not my mother tongue.

@omarkhan
Copy link
Owner

Thanks for the suggestion! Sorry for the late reply. This is mostly handled by the --hide-private flag. If you want to implement the rest, feel free to submit a patch

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

No branches or pull requests

2 participants