Skip to content

Commit

Permalink
put automodapi in docs, small doc style updates
Browse files Browse the repository at this point in the history
  • Loading branch information
emolter committed Oct 1, 2024
1 parent c38478a commit 10378bd
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/stcal/outlier_detection/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ Outlier Detection Utils

description.rst

.. automodapi:: stcal.outlier_detection.median
.. automodapi:: stcal.outlier_detection.utils
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ norecursedirs = [
]
filterwarnings = [
"error::ResourceWarning",
"error:.*finalize.*:pytest.PytestUnraisableExceptionWarning",
"error::pytest.PytestUnraisableExceptionWarning",
]
markers = [
"soctests",
Expand Down
10 changes: 5 additions & 5 deletions src/stcal/outlier_detection/median.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ def nanmedian3D(cube: np.ndarray, overwrite_input: bool = True) -> np.ndarray:
Parameters
----------
cube
3-dimensional array. Will be modified in-place if overwrite_input is True
3-dimensional array. Will be modified in-place if `overwrite_input` is True
overwrite_input
Passed to `np.nanmedian`, if True the input cube will be modified
Passed to ``np.nanmedian``, if True the input cube will be modified
Returns
-------
median
np.ndarray
2-dimensional computed median array
"""
with warnings.catch_warnings():
Expand Down Expand Up @@ -78,7 +78,7 @@ def __init__(self,
buffer_size
The buffer size for the median computation, units of bytes.
Has no effect if in_memory is True.
Has no effect if `in_memory` is True.
dtype
The data type of the input data.
Expand Down Expand Up @@ -134,7 +134,7 @@ def evaluate(self) -> np.ndarray:
Returns
-------
median_data
np.ndarray
The median data computed from the input data.
"""
if self.in_memory:
Expand Down

0 comments on commit 10378bd

Please sign in to comment.