Skip to content

Commit

Permalink
address review
Browse files Browse the repository at this point in the history
  • Loading branch information
d-chambers committed Nov 7, 2024
1 parent 2746f5e commit 0b5c9ce
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions dascore/proc/aggregate.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@
dim_reduce
How to reduce the dimensional coordinate associated with the
aggregated axis. Can be the name of any valid aggregator, a callable,
"empty" - which returns and empty coord, or "squeeze" which drops
the coordinate. For dimensions with datetime or timedelta datatypes,
if the operation fails it will automatically be applied to the
coordinates converted to floats then the output converted back
to the appropriate time type.
"empty" (the default) - which returns and empty coord, or "squeeze"
which drops the coordinate. For dimensions with datetime or timedelta
datatypes, if the operation fails it will automatically be applied
to the coordinates converted to floats then the output converted back
to the appropriate time type.
"""

AGG_NOTES = """
Expand Down Expand Up @@ -106,13 +106,8 @@ def aggregate(
The aggregation to apply along dimension. Options are:
{options}
Notes
-----
- The old dimension is kept but its coordiante values are removed.
use [`Patch.squeeze`](`dascore.Patch.squeeze`) to remove them or
[`Patch.update_coords`](`dascore.Patch.update_coords`) to set a
coordinate value.
See Also
--------
- See also the aggregation shortcut methods in the
[aggregate module](`dascore.proc.aggregate`).
Expand Down

0 comments on commit 0b5c9ce

Please sign in to comment.