Skip to content

Commit 92c14ba

Browse files
jasonb5tomvothecoder
authored andcommitted
Adds documentation section for module-level methods
1 parent a67f12b commit 92c14ba

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

docs/api.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,17 @@ Below is a list of top-level API functions that are available in ``xcdat``.
3939
create_zonal_grid
4040
tutorial.open_dataset
4141

42+
Module-level API Functions
43+
--------------------------
44+
45+
Below is a list of model-level API functions that are available in ``xcdat``.
46+
47+
.. autosummary::
48+
:toctree: generated/
49+
50+
mask.pcmdi_land_sea_mask
51+
52+
4253
Accessors
4354
---------
4455

xcdat/mask.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ def mask_land(
7676
dataset. By default False.
7777
**options : Any
7878
These options are passed directly to the ``method``. See specific
79-
method documentation for available options; :func:`pcmdi_land_sea_mask` for PCMDI options.
79+
method documentation for available options; :func:`mask.pcmdi_land_sea_mask` for PCMDI options.
8080
8181
Returns
8282
-------
@@ -144,7 +144,7 @@ def mask_sea(
144144
dataset. By default False.
145145
**options : Any
146146
These options are passed directly to the ``method``. See specific
147-
method documentation for available options; :func:`pcmdi_land_sea_mask` for PCMDI options
147+
method documentation for available options; :func:`mask.pcmdi_land_sea_mask` for PCMDI options
148148
149149
Returns
150150
-------

0 commit comments

Comments
 (0)