Skip to content

Commit 7e9635f

Browse files
committed
Fix docstring
1 parent db3cdef commit 7e9635f

File tree

1 file changed

+26
-31
lines changed

1 file changed

+26
-31
lines changed

xcdat/temporal.py

+26-31
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ def group_average(
334334
min_weight : float | None, optional
335335
Fraction of data coverage (i..e, weight) needed to return a
336336
temporal average value. Value must range from 0 to 1, by default
337-
None ((equivalent to ``min_weight=0.0``).
337+
None (equivalent to ``min_weight=0.0``).
338338
339339
Returns
340340
-------
@@ -933,36 +933,31 @@ def _set_arg_attrs(
933933
):
934934
"""Validates method arguments and sets them as object attributes.
935935
936-
Parameters
937-
----------
938-
mode : Mode
939-
The mode for temporal averaging.
940-
freq : Frequency
941-
The frequency of time to group by.
942-
weighted : bool
943-
Calculate averages using weights.
944-
season_config: Optional[SeasonConfigInput]
945-
A dictionary for "season" frequency configurations. If configs for
946-
predefined seasons are passed, configs for custom seasons are
947-
ignored and vice versa, by default DEFAULT_SEASON_CONFIG.
948-
min_weight : float | None, optional
949-
Fraction of data coverage (i..e, weight) needed to return a
950-
<<<<<<< Updated upstream
951-
spatial average value. Value must range from 0 to 1, by default None
952-
(equivalent to ``min_weight=0.0``).
953-
=======
954-
temporal average value. Value must range from 0 to 1, by default
955-
None ((equivalent to ``min_weight=0.0``).
956-
>>>>>>> Stashed changes
957-
958-
Raises
959-
------
960-
KeyError
961-
If the Dataset does not have a time dimension.
962-
ValueError
963-
If an incorrect ``freq`` arg was passed.
964-
ValueError
965-
If an incorrect ``dec_mode`` arg was passed.
936+
Parameters
937+
----------
938+
mode : Mode
939+
The mode for temporal averaging.
940+
freq : Frequency
941+
The frequency of time to group by.
942+
weighted : bool
943+
Calculate averages using weights.
944+
season_config: Optional[SeasonConfigInput]
945+
A dictionary for "season" frequency configurations. If configs for
946+
predefined seasons are passed, configs for custom seasons are
947+
ignored and vice versa, by default DEFAULT_SEASON_CONFIG.
948+
min_weight : float | None, optional
949+
Fraction of data coverage (i..e, weight) needed to return a
950+
temporal average value. Value must range from 0 to 1, by default
951+
None (equivalent to ``min_weight=0.0``).
952+
953+
Raises
954+
------
955+
KeyError
956+
If the Dataset does not have a time dimension.
957+
ValueError
958+
If an incorrect ``freq`` arg was passed.
959+
ValueError
960+
If an incorrect ``dec_mode`` arg was passed.
966961
"""
967962
# General configuration attributes.
968963
if mode not in list(MODES):

0 commit comments

Comments
 (0)