Skip to content

Commit

Permalink
update docstring
Browse files Browse the repository at this point in the history
before we returned a list, but now a dict

also update description of the returning dict
  • Loading branch information
TjarkMiener committed Jul 18, 2024
1 parent ccdd5f1 commit 54fed1d
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions src/ctapipe/calib/camera/extractor.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def __call__(
masked_pixels_of_sample=None,
chunk_shift=None,
col_name="image",
) -> list:
) -> dict:
"""
Divide table into chunks and extract the statistical values.
Expand All @@ -62,8 +62,9 @@ def __call__(
Returns
-------
List StatisticsContainer:
List of extracted statistics and extraction chunks
dict
dictionary where keys are the first timestamp of each chunk and values are `StatisticsContainer`
instances containing the extracted statistics (mean, median, std) for that chunk.
"""

# Check if the statistics of the table is sufficient to extract at least one chunk.
Expand Down

0 comments on commit 54fed1d

Please sign in to comment.