review comments

Author: Tom-Willemsen

doc/dev/logging.md

@@ -7,7 +7,7 @@ logger = logging.getLogger(__name__)
 logger.warning("Message to be logged")
 ```
 
-The logger utilizes a `TimedRotatingFileHandler` defined in {py:obj}`ibex_bluesky_core.log` that rolls over the log at midnight.
+The logger utilizes a {py:obj}`~logging.handlers.TimedRotatingFileHandler` that rolls over the log at midnight.
 
 By default, the log files will be created in `c:\instrument\var\logs\bluesky`. This can be configured by setting
 the `IBEX_BLUESKY_CORE_LOGS` environment variable.

src/ibex_bluesky_core/callbacks/__init__.py

@@ -98,7 +98,7 @@ def __init__(  # noqa: PLR0912, PLR0915
         over the exact set of callbacks to be used, individual callbacks may
         be more appropriate.
 
-        By default, the following callbacks are included:
+        By default, the following callbacks are included and enabled:
 
         - :py:obj:`ibex_bluesky_core.callbacks.HumanReadableFileCallback`
 
@@ -301,7 +301,7 @@ def peak_stats(self) -> PeakStats:
 
     @property
     def com(self) -> CentreOfMass:
-        """The centre of mass callback, containing ``ibex_bluesky_core``'s centre of mass."""
+        """The :py:obj:`~ibex_bluesky_core.callbacks.CentreOfMass` callback."""
         if self._com is None:
             raise ValueError("centre of mass was not added as a callback.")
         return self._com

src/ibex_bluesky_core/callbacks/_fitting.py

@@ -50,7 +50,7 @@ def __init__(
         This callback extends the functionality of :py:obj:`bluesky.callbacks.LiveFit` by adding:
 
         - Support for weighting fits by uncertainties. The weights are passed through to the
-          underlying :py:obj:`lmfit.model.Model.fit` routing as ``1/stddev``, if provided.
+          underlying :py:obj:`lmfit.model.Model.fit` routine as ``1/stddev``, if provided.
 
         - Support for dynamic fit guesses, as performed by the models defined in
           :py:obj:`ibex_bluesky_core.fitting`.

src/ibex_bluesky_core/plans/__init__.py

@@ -1,4 +1,4 @@
-"""Generic plans."""
+"""Core plans."""
 
 from collections.abc import Generator
 from typing import TYPE_CHECKING, Any