Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Allow to filter some method names too (like files or dirs) #171

Open
facundobatista opened this issue Dec 29, 2015 · 4 comments
Open

Allow to filter some method names too (like files or dirs) #171

facundobatista opened this issue Dec 29, 2015 · 4 comments

Comments

@facundobatista
Copy link

This will allow the tool to be used in groups where have the convention of not documenting methods like init, or "private_*", or whatever weird name they may use.

So, being able to pass something like "--ignore-methods=foo_" or "--ignore-methods=___" would be great.

Thanks!

@akx
Copy link

akx commented Jan 30, 2016

👍 for this feature.

@larsoner
Copy link
Contributor

This would be useful, I might take a shot at implementing it since we need it for pydocstyle to be useful for us

This was referenced Aug 30, 2016
@Nurdok
Copy link
Member

Nurdok commented Sep 3, 2016

It might be reasonable to allow the user to specify a regex for what is considered "private" and make it default to ^_.* (i.e., "starts with an underscore").

@jayvdb
Copy link
Member

jayvdb commented Sep 3, 2016

If the equivalent of the python 3 qual name was used, this would provide a workaround for #199.
The default regex would need to be roughly ^(.*\.)?_.*$

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

No branches or pull requests

5 participants