Skip to content

Commit 4bb837c

Browse files
Merge pull request #44 from flatironinstitute/hotfix_docstrings
added Raises to docstrings when empty samples or n_samples<=0 is passed
2 parents f1194c3 + 19ca784 commit 4bb837c

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/neurostatslib/basis.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ def evaluate(self, *xi: ArrayLike) -> NDArray:
101101
ValueError
102102
- If the time point number is inconsistent between inputs.
103103
- If the number of inputs doesn't match what the Basis object requires.
104+
- At least one of the samples is empty.
104105
"""
105106
# check that the input is array-like
106107
if any(
@@ -145,12 +146,12 @@ def evaluate_on_grid(self, *n_samples: int) -> Tuple[Tuple[NDArray], NDArray]:
145146
The basis function evaluated at the samples,
146147
shape (n_samples[0], ... , n_samples[n], number of basis).
147148
148-
149149
Raises
150150
------
151151
ValueError
152-
If the time point number is inconsistent between inputs or if the number of inputs doesn't match what
152+
- If the time point number is inconsistent between inputs or if the number of inputs doesn't match what
153153
the Basis object requires.
154+
- If one of the n_samples is <= 0.
154155
155156
Notes
156157
-----

0 commit comments

Comments
 (0)