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

[MAINTENANCE] Renaming Metric Name Suffixes using Enum Values for Better Code Readability #6575

Conversation

alexsherstinsky
Copy link
Contributor

@alexsherstinsky alexsherstinsky commented Dec 13, 2022

Scope

The Metrics layer utilizes a naming scheme that corresponds to Map metrics, Condition metrics, Aggregate metrics, and others. These are properly delineated by Enum values with corresponding suffixes in ExecutionEngine module. However, in other Metrics modules, strings are used to designate Metric function types, which makes reading this already highly complex code even more difficult, unnecessarily. This effort improves the readability by using enums and meaningful variable names consistently.

Please annotate your PR title to describe what the PR does, then give a brief bulleted description of your PR below. PR titles should begin with [BUGFIX], [FEATURE], [DOCS], or [MAINTENANCE]. If a new feature introduces breaking changes for the Great Expectations API or configuration files, please also add [BREAKING]. You can read about the tags in our contributor checklist.

Changes proposed in this pull request:

  • JIRA: GREAT-1347/GREAT-181/GREAT-1445

After submitting your PR, CI checks will run and @cla-bot will check for your CLA signature.

For a PR with nontrivial changes, we review with both design-centric and code-centric lenses.

In a design review, we aim to ensure that the PR is consistent with our relationship to the open source community, with our software architecture and abstractions, and with our users' needs and expectations. That review often starts well before a PR, for example in github issues or slack, so please link to relevant conversations in notes below to help reviewers understand and approve your PR more quickly (e.g. closes #123).

Previous Design Review notes:

Definition of Done

Please delete options that are not relevant.

  • My code follows the Great Expectations style guide
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added unit tests where applicable and made sure that new and existing tests are passing.
  • I have run any local integration tests and made sure that nothing is broken.

Thank you for submitting!

@netlify
Copy link

netlify bot commented Dec 13, 2022

Deploy Preview for niobium-lead-7998 ready!

Name Link
🔨 Latest commit bc32d02
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/63990e7f33e9f90009293bce
😎 Deploy Preview https://deploy-preview-6575--niobium-lead-7998.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@ghost
Copy link

ghost commented Dec 13, 2022

👇 Click on the image for a new way to code review
  • Make big changes easier — review code in small groups of related files

  • Know where to start — see the whole change at a glance

  • Take a code tour — explore the change with an interactive tour

  • Make comments and review — all fully sync’ed with github

    Try it now!

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map Legend

@alexsherstinsky alexsherstinsky requested a review from a team December 13, 2022 21:13
@alexsherstinsky alexsherstinsky marked this pull request as ready for review December 13, 2022 21:13
@alexsherstinsky alexsherstinsky enabled auto-merge (squash) December 13, 2022 21:13
…45/alexsherstinsky/batch_metric_store/metrics/execution_engine/standardize_metric_names_using_proper_enum_values-2022_12_13-277
@alexsherstinsky alexsherstinsky force-pushed the maintenance/GREAT-1347/GREAT-181/GREAT-1445/alexsherstinsky/batch_metric_store/metrics/execution_engine/standardize_metric_names_using_proper_enum_values-2022_12_13-277 branch from 69f9552 to 36df2fe Compare December 13, 2022 21:41
@alexsherstinsky alexsherstinsky enabled auto-merge (squash) December 13, 2022 21:42
Alex Sherstinsky added 2 commits December 13, 2022 14:53
…45/alexsherstinsky/batch_metric_store/metrics/execution_engine/standardize_metric_names_using_proper_enum_values-2022_12_13-277
@alexsherstinsky alexsherstinsky force-pushed the maintenance/GREAT-1347/GREAT-181/GREAT-1445/alexsherstinsky/batch_metric_store/metrics/execution_engine/standardize_metric_names_using_proper_enum_values-2022_12_13-277 branch from c4f907b to 1111d3e Compare December 13, 2022 22:54
Copy link
Contributor

@billdirks billdirks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

…erstinsky/batch_metric_store/metrics/execution_engine/standardize_metric_names_using_proper_enum_values-2022_12_13-277
@alexsherstinsky alexsherstinsky merged commit 117effa into develop Dec 14, 2022
@alexsherstinsky alexsherstinsky deleted the maintenance/GREAT-1347/GREAT-181/GREAT-1445/alexsherstinsky/batch_metric_store/metrics/execution_engine/standardize_metric_names_using_proper_enum_values-2022_12_13-277 branch December 14, 2022 00:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants