From 82c630d3b4275e41b83de275066d72790d1be2dc Mon Sep 17 00:00:00 2001 From: JamesWrigley Date: Wed, 18 Dec 2024 16:30:24 +0100 Subject: [PATCH] Minor docs fixes - Fixed changelog formatting - Fixed some warnings from mkdocs about not being able to get argument types --- docs/changelog.md | 1 + src/extra/components/timepix.py | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index e25567c9..d57e807a 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -17,6 +17,7 @@ ``` Added: + - [Timepix3][extra.components.Timepix3] to access raw hits and centroids from the Timepix3 detector (!231). - [Scan.plot()][extra.components.Scan.plot] now allows passing a `figsize` (!262). diff --git a/src/extra/components/timepix.py b/src/extra/components/timepix.py index e72d49d2..9538b97f 100644 --- a/src/extra/components/timepix.py +++ b/src/extra/components/timepix.py @@ -379,7 +379,7 @@ def spatial_bins(self, min_pos=0, max_pos=256, bins_per_px=1): 1 by default Returns: - bins (numpy.ndarray) Spatial bin edges. + bins (numpy.ndarray): Spatial bin edges. """ return np.arange(min_pos, max_pos, 1/bins_per_px) - 0.5/bins_per_px @@ -410,8 +410,8 @@ def pixel_events(self, pulse_dim='pulseId', toa_offset=0.0, default. toa_offset (float, optional): Time-of-arrival offset applied by train in microseconds, 0.0 by default. - timewalk_lut (numpy.typing.ArrayLike or os.PathLike or None, - optional): Timewalk LUT to correct ToA or path to a file + timewalk_lut (numpy.typing.ArrayLike or os.PathLike or None, optional): + Timewalk LUT to correct ToA or path to a file compatible with np.load, none by default. out_of_pulse_events (bool, optional): Whether to include hits before the first pulse and after the last pulse in