Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WORK IN PROGRESS
Description
This PR renames the following methods.
describe_realms
get_realm_metadata
describe_metrics
get_metric_metadata
describe_dimensions
get_dimension_metadata
describe_raw_realms
get_raw_realm_metadata
describe_raw_fields
get_raw_field_metadata
get_filter_values
get_dimension_data
The old method names will still work but are given deprecation warnings.
Motivation and Context
The goal is to use more consistent and specific method names.
We got feedback that it's hard to keep track of which methods start with
describe
and which start withget
.get_filter_values
is renamed toget_dimension_data
since these data will also be useful outside the context of filtering, especially with #35.Tests performed
Types of changes
Checklist:
CHANGELOG.md
has been updateddocs/developing.md
) produces no errorsxdmod-notebooks
repository as necessary, and the notebooks all run successfully