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

ACL Filtering #280

Open
rstone4-chwy opened this issue Jul 18, 2022 · 2 comments
Open

ACL Filtering #280

rstone4-chwy opened this issue Jul 18, 2022 · 2 comments

Comments

@rstone4-chwy
Copy link

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?

@dduan
Copy link
Owner

dduan commented Jul 18, 2022

A PR sounds great! Can you describe what you have in mind? Would it be

  • a binary flag that makes check/formatting/extracting public only (--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.

@rstone4-chwy
Copy link
Author

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.

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