Draft
Conversation
10 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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_realmsget_realm_metadatadescribe_metricsget_metric_metadatadescribe_dimensionsget_dimension_metadatadescribe_raw_realmsget_raw_realm_metadatadescribe_raw_fieldsget_raw_field_metadataget_filter_valuesget_dimension_dataThe 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
describeand which start withget.get_filter_valuesis renamed toget_dimension_datasince these data will also be useful outside the context of filtering, especially with #35.Tests performed
Types of changes
Checklist:
CHANGELOG.mdhas been updateddocs/developing.md) produces no errorsxdmod-notebooksrepository as necessary, and the notebooks all run successfully