ACL Filtering
Opened this issue · 2 comments
My team is starting to use DrString, but we're hitting a scenario that the library doesn't seem to support. We care that our publicly documented methods and variables are correct, but methods with internal ACL do not need to be validated. Is it possible to only validate public variables and methods? If not would you accept a PR to implement such a behavior?
A PR sounds great! Can you describe what you have in mind? Would it be
- a binary flag that makes check/formatting/extracting
publiconly (--public-only) - an option that specify the minimal level (
--min-acl) - a list of ACLs (
--acl public --acl internal)
No matter what we pick, the default behavior should remain the same.
I hadn't gotten that far with the design. Passing a list of ACLS seems like it would be the most flexible. I don't imagine many people wanting to verify private docs but not public, but there's always someone who has a specific need.