Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix reST syntax in PseudoPositioner #1192

Merged
merged 2 commits into from
May 31, 2024
Merged

Fix reST syntax in PseudoPositioner #1192

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c2b525
DOC #1192 as noted
prjemian May 16, 2024
8ebb8a0
DOC #1192 apply to similar
prjemian May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions ophyd/pseudopos.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ def _setup_move(self, position, status):
def move(self, pos, **kwargs):
"""Move this pseudo axis to a specific position.

See `PseudoPositioner.move_single` for more information.
See ``PseudoPositioner.move_single`` for more information.

Parameters
----------
Expand Down Expand Up @@ -522,11 +522,11 @@ def _pseudo_position_tuple(cls):
def _get_pseudo_positioners(cls):
"""Inspect the components and find the pseudo positioners

All `PseudoSingle` (and subclassed) components will be returned, by
All ``PseudoSingle`` (and subclassed) components will be returned, by
default.

The built-in mechanism to override the list of pseudo positioners on a
PseudoPositioner is to define '_pseudo' on the class-level. It should
``PseudoPositioner`` is to define ``_pseudo`` on the class-level. It should
be a list of attribute names.

Yields
Expand All @@ -545,11 +545,11 @@ def _get_pseudo_positioners(cls):
def _get_real_positioners(cls):
"""Inspect the components and find the real positioners

All `Positioner` components which are not `PseudoSingle`s will be
All ``Positioner`` components which are not ``PseudoSingle`` objects will be
returned, by default.

The built-in mechanism to override the list of real positioners on a
PseudoPositioner is to define '_real' on the class-level. It should be
``PseudoPositioner`` is to define ``_real`` on the class-level. It should be
a list of attribute names. This allows you to group real motors
logically on the device but not have them included in motions or
calculations.
Expand Down Expand Up @@ -748,7 +748,7 @@ def _real_finished(self, status=None, *, obj=None):
"""Callback: A single real positioner has finished moving.

Used for asynchronous motion, if all have finished moving then fire a
callback (via `Positioner._done_moving`)
callback (via ``Positioner._done_moving``)
"""
with self._finished_lock:
real = obj
Expand All @@ -765,7 +765,7 @@ def move_single(self, pseudo, position, **kwargs):

All other positioners will use their current setpoint/target value, if
available. Failing that, their current readback value will be used (see
`PseudoSingle.sync` and `PseudoSingle.target`).
``PseudoSingle.sync`` and ``PseudoSingle.target``).

Parameters
----------
Expand Down Expand Up @@ -878,7 +878,7 @@ def move(self, position, wait=True, timeout=None, moved_cb=None):
Raises
------
TimeoutError
When motion takes longer than `timeout`
When motion takes longer than ``timeout``
ValueError
On invalid positions
RuntimeError
Expand All @@ -902,7 +902,7 @@ def _setup_move(self, position, status):
Parameters
----------
position : PseudoPosition
Position to move to (already verified by `check_value`)
Position to move to (already verified by ``check_value``)
status : MoveStatus
Status object created by PositionerBase.move()
"""
Expand Down
Loading