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

rename some types, fields, functions, and variables related to common types #1065

Merged
merged 4 commits into from
Jul 16, 2024

Conversation

cdisselkoen
Copy link
Contributor

Description of changes

On the heels of #1059, and following this comment on #1060, this PR renames a bunch of other types, fields, functions, and variables related to common types.

  • Explicitly use "common type" instead of "typedef" where it makes sense, following our docs
  • Distinguish between "type_defs" (definitions of common types) and "type_refs" (references to common types)
  • Make a couple field names more concise (to change e.g. self.type_defs.type_defs into self.common_types.defs)

I believe that none of the changes here are breaking, or even visible outside the cedar-policy-validator crate. The field renames are in structs that don't impl Serialize or Deserialize, and the types and functions are crate-private. Happy to be corrected if I'm wrong.

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>
…-renames

Signed-off-by: Craig Disselkoen <cdiss@amazon.com>
@cdisselkoen cdisselkoen merged commit fdcd703 into main Jul 16, 2024
18 checks passed
@cdisselkoen cdisselkoen deleted the cdisselkoen/validator-renames branch July 16, 2024 13:10
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