Skip to content

Commit eb54edc

Browse files
committed
Docstring tweak
1 parent ee69331 commit eb54edc

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

src/CSET/operators/plot.py

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -130,13 +130,13 @@ def spatial_contour_plot(
130130
----------
131131
cube: Cube
132132
An iris cube of the data to plot. It should be 2 dimensional (lat and lon).
133-
filename: pathlike
134-
The path of the plot to write.
133+
filename: pathlike, optional
134+
The path of the plot to write. Defaults to the recipe name.
135135
136136
Returns
137137
-------
138138
Cube
139-
The inputted cube (so further operations can be applied)
139+
The original cube (so further operations can be applied)
140140
141141
Raises
142142
------
@@ -168,15 +168,15 @@ def postage_stamp_contour_plot(
168168
----------
169169
cube: Cube
170170
Iris cube of data to be plotted. It must have a realization coordinate.
171-
filename: pathlike
172-
The path of the plot to write.
171+
filename: pathlike, optional
172+
The path of the plot to write. Defaults to the recipe name.
173173
coordinate: str
174174
The coordinate that becomes different plots. Defaults to "realization".
175175
176176
Returns
177177
-------
178178
Cube
179-
The inputted cube (so further operations can be applied)
179+
The original cube (so further operations can be applied)
180180
181181
Raises
182182
------
@@ -230,12 +230,15 @@ def time_series_contour_plot(
230230
Parameters
231231
----------
232232
cube: Cube
233-
An iris cube of the data to plot. It should be 2 dimensional (lat and lon).
233+
An iris cube of the data to plot. It should be 2 dimensional (lat and
234+
lon).
235+
filename: pathlike, optional
236+
Common component of the plot filenames. Defaults to the recipe name.
234237
235238
Returns
236239
-------
237240
Cube
238-
The input cube (so further operations can be applied)
241+
The original cube (so further operations can be applied)
239242
240243
Raises
241244
------

0 commit comments

Comments
 (0)