@@ -145,16 +145,23 @@ def collapse_by_hour_of_day(
145145 cube: iris.cube.Cube | iris.cube.CubeList
146146 Cube to collapse and iterate over one dimension or CubeList to
147147 convert to a cube and then collapse prior to aggregating by hour.
148- If a CubeList is provided multi_case must be True. A cube that only
149- contains one time dimension must have multi_case set to False; a cube
148+ If a CubeList is provided multi_case must be set to True as the Cube List
149+ should only contain cubes of multiple dates and not different variables
150+ or models. A cube that only contains one time dimension must have
151+ multi_case set to False as it contains only one forecast. A cube
150152 containing two time dimensions, e.g., 'forecast_reference_time' and
151- 'forecast_period' must have multi_case set to True.
153+ 'forecast_period' must have multi_case set to True as it will contain
154+ multiple forecasts.
152155 method: str
153156 Type of collapse i.e. method: 'MEAN', 'MAX', 'MIN', 'MEDIAN',
154157 'PERCENTILE'. For 'PERCENTILE' the additional_percent must be specified.
155158 multi_case: boolean, optional
156159 Default is True. If True multiple cases will be aggregated by hour of
157160 day; if False a single forecast will be aggregated by hour of day.
161+ Information around the usage of multi_case is provided above under the
162+ description for the cube argument. It is kept as an argument rather
163+ than being automatically generated to maintain traceability for the
164+ users actions.
158165
159166 Returns
160167 -------
0 commit comments