Closed simonw closed 1 year ago
My main use-case for this is a CI check which enforces documentation on everything except for private functions and methods:
symbex --unprivate --undocumented --check
For that example though I do think this might feel more natural:
symbex --public --undocumented --check
I think classes with a leading _
in their name _MyClass
should be treated as matching the private filter too.
Maybe like this:
--private
- only functions and methods with a name that starts with_
--unprivate
(or--public
- but--unprivate
is more consistent with--undocumented and
--untypedand
--unasync`) - exclude those private methods and functions--dunder
- only functions and methods that match are__blah__
.Open question: should
--private
return__init__
etc? Are dunder methods considered private? I think probably not.