Skip to content

Commit 3706cf2

Browse files
committed
add check_x funcs to API list
1 parent e285624 commit 3706cf2

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

doc/api.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,15 @@ Associated objects allow for defining mode parameters.
120120

121121
ParamDefinition
122122

123+
Utility to check for available fit modes.
124+
125+
.. currentmodule:: specparam.modes.definitions
126+
127+
.. autosummary::
128+
:toctree: generated/
129+
130+
check_modes
131+
123132
Metrics
124133
~~~~~~~
125134

@@ -132,6 +141,15 @@ An object for defining metrics.
132141

133142
Metric
134143

144+
Utility to check for available metrics.
145+
146+
.. currentmodule:: specparam.metrics.definitions
147+
148+
.. autosummary::
149+
:toctree: generated/
150+
151+
check_metrics
152+
135153
Data
136154
~~~~
137155

0 commit comments

Comments
 (0)