Patch 1

docs/user/explanations/staging.rst

@@ -33,7 +33,7 @@ back off (or back to its original setting, whatever that was) at the end.
 For this, ophyd provides a convenience, ``stage_sigs`` --- a dictionary
 mapping signals to desired values. The device reads the initial values
 of these signals, stashes them, changes them to the desired value, and then
-restore the initial value when the device is unstaged. It is best to
+restores the initial value when the device is unstaged. It is best to
 customize ``stage_sigs`` in the device's ``__init__`` method, like so:
 
 .. code:: python

docs/user/explanations/status.rst

@@ -26,7 +26,7 @@ default, ``None`` means it will wait forever to be marked completed.)
 
 .. code:: python
 
-   from ophyd import Status
+   from ophyd.status import Status
 
    status = Status(timeout=60)
 

docs/user/how-to/pseudopositioner.md

@@ -16,7 +16,7 @@ from ophyd.pseudopos import (
 from ophyd import Component, SoftPositioner
 
 
-class SPseudo3x3(PseudoPositioner):
+class Pseudo3x3(PseudoPositioner):
     """
     Interface to three positioners in a coordinate system that flips the sign.
     """
@@ -30,7 +30,7 @@ class SPseudo3x3(PseudoPositioner):
 
     @pseudo_position_argument
     def forward(self, pseudo_pos):
-        "Given a position in the psuedo coordinate system, transform to the real coordinate system."
+        "Given a position in the pseudo coordinate system, transform to the real coordinate system."
         return self.RealPosition(
             real1=-pseudo_pos.pseudo1,
             real2=-pseudo_pos.pseudo2,

docs/user/reference/signals.rst

@@ -3,16 +3,16 @@
 Signals
 *******
 
-In EPICS, **Signal** maybe backed by a read-only PV, a single
-read-write PV, or a pair of read and write PVs, grouped together.  In
+In EPICS, a **Signal** may be backed by a read-only PV, a single
+read-write PV, or a pair of read-write PVs grouped together.  In
 any of those cases, a single value is exposed to `bluesky
 <https://nsls-ii.github.io/bluesky>`_.  For more complex hardware, for
 example a `motor record
 <http://www.aps.anl.gov/bcda/synApps/motor/>`_, the relationships
-between the individual process variables needs to be encoded in a
-:class:`~device.Device` (a :class:`~epics_motor.EpicsMotor` class
+among the individual PVs needs to be encoded in a
+:class:`~device.Device` (an :class:`~epics_motor.EpicsMotor` class
 ships with ophyd for this case).  This includes both what **Signals**
-are grouped together, but also how to manipulate them a coordinated
+are grouped together, but also how to manipulate them in a coordinated
 fashion to achieve the high-level action (moving a motor, changing a
 temperature, opening a valve, or taking data).  More complex devices,
 like a diffractometer or a Area Detector, can be assembled out of

ophyd/device.py

@@ -44,7 +44,7 @@
 
 A, B = TypeVar("A"), TypeVar("B")
 ALL_COMPONENTS = object()
-# This attrs are defined at instanitation time and must not
+# These attrs are defined at instantiation time and must not
 # collide with class attributes.
 DEVICE_INSTANCE_ATTRS = {
     "name",
@@ -412,7 +412,7 @@ def maybe_add_prefix(self, instance, kw, suffix):
 
 
 class DynamicDeviceComponent(Component["Device"]):
-    """An Device component that dynamically creates an ophyd Device
+    """A Device component that dynamically creates an ophyd Device
 
     Parameters
     ----------
@@ -516,8 +516,8 @@ def subscriptions(self, event_type):
         )
 
 
-# These stub 'Interface' classes are the apex of the mro heirarchy for
-# their respective methods. They make multiple interitance more
+# These stub 'Interface' classes are the apex of the mro hierarchy for
+# their respective methods. They make multiple inheritance more
 # forgiving, and let us define classes that customize these methods
 # but are not full Devices.
 
@@ -575,7 +575,7 @@ def read(self) -> OrderedDictType[str, Dict[str, Any]]:
         :meth:`~BlueskyInterface.describe()`.
 
         By convention, the first key in the return is the 'primary' key
-        and maybe used by heuristics in :mod:`bluesky`.
+        and may be used by heuristics in :mod:`bluesky`.
 
         The values in the ordered dictionary must be dict (-likes) with the
         keys ``{'value', 'timestamp'}``.  The ``'value'`` may have any type,
@@ -593,7 +593,7 @@ def read(self) -> OrderedDictType[str, Dict[str, Any]]:
     def describe(self) -> OrderedDictType[str, Dict[str, Any]]:
         """Provide schema and meta-data for :meth:`~BlueskyInterface.read`.
 
-        This keys in the `OrderedDict` this method returns must match the
+        The keys in the `OrderedDict` this method returns must match the
         keys in the `OrderedDict` return by :meth:`~BlueskyInterface.read`.
 
         This provides schema related information, (ex shape, dtype), the
@@ -747,11 +747,11 @@ def pause(self) -> None:
         This is called when ever the
         :obj:`~bluesky.run_engine.RunEngine` is interrupted.
 
-        A device may have internal state that means plans can not
+        A device may have internal state that means plans cannot
         safely be re-wound.  This method may: put the device in a
         'paused' state and/or raise
         :obj:`~bluesky.run_engine.NoReplayAllowed` to indicate that
-        the plan can not be rewound.
+        the plan cannot be rewound.
 
         Raises
         ------
@@ -957,7 +957,7 @@ def _initialize_device(cls):
 
         # this is so that the _sig_attrs class attribute includes the sigattrs
         # from all of its class-inheritance-parents so we do not have to do
-        # this look up everytime we look at it.
+        # this look up every time we look at it.
         base_devices = [
             base for base in reversed(cls.__bases__) if hasattr(base, "_sig_attrs")
         ]
@@ -1271,7 +1271,7 @@ def __set_kinds_according_to_list(
             lambda x: x[0],
         )
 
-        # we are into grand-children, can not be lazy!
+        # we are into grand-children, cannot be lazy!
         for child, cf_list in group:
             cpt = getattr(self, child)
             cpt.kind |= set_kind