Skip to content

Rename dimension parameter to group_by.#34

Draft
aaronweeden wants to merge 2 commits intoubccr:mainfrom
aaronweeden:rename-dimension-to-group-by
Draft

Rename dimension parameter to group_by.#34
aaronweeden wants to merge 2 commits intoubccr:mainfrom
aaronweeden:rename-dimension-to-group-by

Conversation

@aaronweeden
Copy link

@aaronweeden aaronweeden commented Oct 30, 2024

WORK IN PROGRESS

Description

This PR renames the dimension parameter of the get_data() method to group_by.

The dimension parameter will still work but is given a deprecation warning.

Motivation and Context

The goal is to have a parameter name that is more accurate and clear. Dimensions can be used for both grouping and filtering. In this case, the dimension is used for grouping.

Tests performed

Types of changes

  • Refactoring / documentation update (non-breaking change which does not change functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Release preparation

Checklist:

  • CHANGELOG.md has been updated
  • The milestone is set correctly on the pull request
  • The appropriate labels have been added to the pull request
  • Running the automated tests (see docs/developing.md) produces no errors
  • Updates have been made to the xdmod-notebooks repository as necessary, and the notebooks all run successfully

@aaronweeden aaronweeden added the enhancement New feature or request label Oct 30, 2024
@aaronweeden aaronweeden added this to the 2.0.0 milestone Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant