From c8278a30ffaa372cd327d097130612807a5c95e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Mo=C4=87ko?= <67100892+mockoocy@users.noreply.github.com> Date: Tue, 25 Feb 2025 11:55:08 +0100 Subject: [PATCH] Fix module docstring formatting Co-authored-by: fabcor --- mxcubecore/HardwareObjects/TangoShutter.py | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/mxcubecore/HardwareObjects/TangoShutter.py b/mxcubecore/HardwareObjects/TangoShutter.py index 3130aaaceb..b1eae2ae0e 100644 --- a/mxcubecore/HardwareObjects/TangoShutter.py +++ b/mxcubecore/HardwareObjects/TangoShutter.py @@ -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 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 ```` property is optional. """ import json