Skip to content

Commit ea86eb1

Browse files
Iqbal-dev12haileyajohnson
authored andcommitted
Reformat docstrings in plotting.py to Google style
Updated all function docstrings in plotting.py to follow Google-style formatting for consistency with the rest of the project. Removed the previous NumPy-style section headers ("Parameters", "Returns") and replaced them with "Args" and "Returns" blocks. Also ensured that no external or unrelated library references remain.
1 parent 5d810bf commit ea86eb1

File tree

1 file changed

+19
-38
lines changed

1 file changed

+19
-38
lines changed

cdippy/plotting.py

Lines changed: 19 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,12 @@ def make_annual_hs_boxplot(stn: str, year: int) -> Figure:
66
"""
77
Create a boxplot of annual significant wave heights for a given station and year.
88
9-
Parameters
10-
----------
11-
stn : str
12-
A 5-character station identifier, e.g., '100p1'.
13-
year : int
14-
The year for which the boxplot is generated.
9+
Args:
10+
stn (str): A 5-character station identifier, e.g., '100p1'.
11+
year (int): The year for which the boxplot is generated.
1512
16-
Returns
17-
-------
18-
fig : Figure
19-
A matplotlib Figure object representing the annual wave height boxplot.
13+
Returns:
14+
Figure: A matplotlib Figure object representing the annual wave height boxplot.
2015
"""
2116
return plots.annual_hs_boxplot.make_plot(stn, year)
2217

@@ -27,23 +22,15 @@ def make_compendium_plot(
2722
"""
2823
Generate CDIP's compendium plot for multiple stations and parameters over a time range.
2924
30-
Parameters
31-
----------
32-
stns : str
33-
Comma-delimited list of 5-character station identifiers, e.g., '100p1,201p1'.
34-
start : str
35-
Start time formatted as 'yyyymm[ddHHMMss]'; optional components default to zero.
36-
end : str
37-
End time formatted as 'yyyymm[ddHHMMss]'. If None, defaults to current date/time.
38-
params : str
39-
Comma-delimited string of parameter names, e.g., 'waveHs,waveTp'.
40-
x_inch : int
41-
Width of the figure in inches.
25+
Args:
26+
stns (str): Comma-delimited list of 5-character station identifiers, e.g., '100p1,201p1'.
27+
start (str): Start time formatted as 'yyyymm[ddHHMMss]'; optional components default to zero.
28+
end (str): End time formatted as 'yyyymm[ddHHMMss]'. If None, defaults to current date/time.
29+
params (str): Comma-delimited string of parameter names, e.g., 'waveHs,waveTp'.
30+
x_inch (int): Width of the figure in inches.
4231
43-
Returns
44-
-------
45-
fig : Figure
46-
A matplotlib Figure object representing the compendium plot.
32+
Returns:
33+
Figure: A matplotlib Figure object representing the compendium plot.
4734
"""
4835
return plots.compendium.make_plot(stns, start, end, params, x_inch)
4936

@@ -54,18 +41,12 @@ def make_sst_climatology_plot(
5441
"""
5542
Plot the yearly climatology of sea surface temperature for a given station over all available years.
5643
57-
Parameters
58-
----------
59-
stn : str
60-
A 5-character station identifier, e.g., '100p1'.
61-
x_inch : int, optional
62-
Width of the figure in inches. Default is None.
63-
y_inch : int, optional
64-
Height of the figure in inches. Default is None.
44+
Args:
45+
stn (str): A 5-character station identifier, e.g., '100p1'.
46+
x_inch (int, optional): Width of the figure in inches. Defaults to None.
47+
y_inch (int, optional): Height of the figure in inches. Defaults to None.
6548
66-
Returns
67-
-------
68-
fig : Figure
69-
A matplotlib Figure object representing the SST climatology plot.
49+
Returns:
50+
Figure: A matplotlib Figure object representing the SST climatology plot.
7051
"""
7152
return plots.sst_climatology.make_plot(stn, x_inch, y_inch)

0 commit comments

Comments
 (0)