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

Bunch more comments and docstrings in cedar-policy-validator #1003

Merged
merged 13 commits into from
Jun 20, 2024

Conversation

cdisselkoen
Copy link
Contributor

Description of changes

Add more comments and docstrings through cedar-policy-validator.

Brings cedar-policy-validator to the same warning/clippy settings we use for cedar-policy.

Many of these changes are unremarkable, but careful review is requested for some of the invariants/assumptions newly documented in namespace_def.rs.

No functional changes.

Issue #, if available

Checklist for requesting a review

The change in this PR is (choose one, and delete the other options):

  • A change "invisible" to users (e.g., documentation, changes to "internal" crates like cedar-policy-core, cedar-validator, etc.)

I confirm that this PR (choose one, and delete the other options):

  • Does not update the CHANGELOG because my change does not significantly impact released code.

I confirm that cedar-spec (choose one, and delete the other options):

  • Does not require updates because my change does not impact the Cedar formal model or DRT infrastructure.

Signed-off-by: Craig Disselkoen <cdiss@amazon.com>
Signed-off-by: Craig Disselkoen <cdiss@amazon.com>
Signed-off-by: Craig Disselkoen <cdiss@amazon.com>
Signed-off-by: Craig Disselkoen <cdiss@amazon.com>
…-comments

Signed-off-by: Craig Disselkoen <cdiss@amazon.com>
…-comments

Signed-off-by: Craig Disselkoen <cdiss@amazon.com>
Signed-off-by: Craig Disselkoen <cdiss@amazon.com>
Signed-off-by: Craig Disselkoen <cdiss@amazon.com>
Signed-off-by: Craig Disselkoen <cdiss@amazon.com>
Signed-off-by: Craig Disselkoen <cdiss@amazon.com>
Signed-off-by: Craig Disselkoen <cdiss@amazon.com>
@cdisselkoen
Copy link
Contributor Author

I believe the DRT and Java CI failures are due to #983 and not this PR. Ready for re-review.

@cdisselkoen cdisselkoen merged commit 959ad4f into main Jun 20, 2024
13 of 17 checks passed
@cdisselkoen cdisselkoen deleted the cdisselkoen/validator-comments branch June 20, 2024 20:13
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

Successfully merging this pull request may close these issues.

3 participants