Skip to content

Commit

Permalink
Fix module docstring formatting
Browse files Browse the repository at this point in the history
Co-authored-by: fabcor <fabien.coronis@maxiv.lu.se>
  • Loading branch information
2 people authored and marcus-oscarsson committed Feb 26, 2025
1 parent d577bc3 commit c8278a3
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions mxcubecore/HardwareObjects/TangoShutter.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,18 @@
adds specific tango shutter states.
When redefining a known state, only the VALUES Enum will be updated.
When defining a new state (new key), the dictionary value should be a
list. The new state is added to both the VALUES and the SPECIFIC_STATES Enum.
list. The new state is added to both the ``VALUES`` and the ``SPECIFIC_STATES`` enumeration.
Attention:
- do not use tuples or the python json parser will fail!
- make sure only double quotes are used inside the values dictionary. No single quotes (') are allowed !
- the second element of the list should be a standard HardwareObjectState name
(UNKNOWN, WARNING, BUSY, READY, FAULT, OFF - see in BaseHardwareObjects.py)!
The <values> property is optional.
- do not use tuples or the Python JSON parser will fail!
- make sure only double quotes (``"``) are used inside the values dictionary,
no single quotes (``'``) are allowed!
- the second element of the list should be a standard ``HardwareObjectState`` name
(``UNKNOWN``, ``WARNING``, ``BUSY``, ``READY``, ``FAULT``, or ``OFF``;
see in ``BaseHardwareObjects``)!
The ``<values>`` property is optional.
"""

import json
Expand Down

0 comments on commit c8278a3

Please sign in to comment.