Skip to content

Commit

Permalink
Minor docs fixes
Browse files Browse the repository at this point in the history
- Fixed changelog formatting
- Fixed some warnings from mkdocs about not being able to get argument types
  • Loading branch information
JamesWrigley committed Dec 18, 2024
1 parent 5711f1a commit 82c630d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
6 changes: 3 additions & 3 deletions src/extra/components/timepix.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 82c630d

Please sign in to comment.