Skip to content

Commit 64b0d02

Browse files
authored
docs: remove example sections from plotting.py
The docstrings for plotting functions previously included example sections that referenced external libraries and interactive code (e.g., matplotlib usage with fig.show()). These examples were removed to keep the documentation clean, consistent, and focused only on parameters and return values. This improves clarity and avoids confusion for users while maintaining a standard NumPy-style docstring format across the module.
1 parent f950e33 commit 64b0d02

1 file changed

Lines changed: 1 addition & 16 deletions

File tree

cdippy/plotting.py

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,6 @@ def make_annual_hs_boxplot(stn: str, year: int) -> Figure:
1717
-------
1818
fig : Figure
1919
A matplotlib Figure object representing the annual wave height boxplot.
20-
21-
Example
22-
-------
23-
>>> fig = make_annual_hs_boxplot('100p1', 2023)
24-
>>> fig.show()
2520
"""
2621
return plots.annual_hs_boxplot.make_plot(stn, year)
2722

@@ -30,7 +25,7 @@ def make_compendium_plot(
3025
stns: str, start: str, end: str, params: str, x_inch: int
3126
) -> Figure:
3227
"""
33-
Generate CDIP's classic compendium plot for multiple stations and parameters over a time range.
28+
Generate CDIP's compendium plot for multiple stations and parameters over a time range.
3429
3530
Parameters
3631
----------
@@ -49,11 +44,6 @@ def make_compendium_plot(
4944
-------
5045
fig : Figure
5146
A matplotlib Figure object representing the compendium plot.
52-
53-
Example
54-
-------
55-
>>> fig = make_compendium_plot('100p1,201p1', '202301', '202312', 'waveHs,waveTp', 10)
56-
>>> fig.show()
5747
"""
5848
return plots.compendium.make_plot(stns, start, end, params, x_inch)
5949

@@ -77,10 +67,5 @@ def make_sst_climatology_plot(
7767
-------
7868
fig : Figure
7969
A matplotlib Figure object representing the SST climatology plot.
80-
81-
Example
82-
-------
83-
>>> fig = make_sst_climatology_plot('100p1', x_inch=8, y_inch=6)
84-
>>> fig.show()
8570
"""
8671
return plots.sst_climatology.make_plot(stn, x_inch, y_inch)

0 commit comments

Comments
 (0)