Rename accessor classes and methods for API consistency #142
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.
Description
The goal of this PR is to make the API naming convention consistent across accessor classes.
The
Dataset
portion of accessor class names are removed because it is redundant.xcdat.XCDATAccessor
public API names with other accessor classes #140DatasetBoundsAccessor
toBoundsAccessor
(breaking change)DatasetSpatialAverageAccessor
toSpatialAverageAccessor
(breaking change)SpatialAverageAccessor.avg()
toSpatialAverageAccessor.spatial_avg()
(breaking change).avg()
was because the accessor class and decorator (ds.spatial.avg
) already describes what the averaging operation was targeting. However, it was not aligned withds.xcdat.spatial_avg()
, which can throw users off.SpatialAverageAccessor
classxcdat.__init__.py
xcdat.py
Checklist
If applicable:
v0.2.0
changelog