Skip to content

Commit a79423f

Browse files
committed
Fix indentation in subclassing notes.
1 parent 88dcbf8 commit a79423f

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/labthings_fastapi/thing.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,25 +49,25 @@ class Thing:
4949
Subclassing Notes
5050
-----------------
5151
52-
* ``__init__``: You should accept any arguments you need to configure the Thing
52+
* ``__init__``: You should accept any arguments you need to configure the Thing
5353
in ``__init__``. Don't initialise any hardware at this time, as your Thing may
5454
be instantiated quite early, or even at import time. You must make sure to
5555
call ``super().__init__(thing_server_interface)``\ .
56-
* ``__enter__(self)`` and ``__exit__(self, exc_t, exc_v, exc_tb)`` are where you
56+
* ``__enter__(self)`` and ``__exit__(self, exc_t, exc_v, exc_tb)`` are where you
5757
should start and stop communications with the hardware. This is Python's
5858
"context manager" protocol. The arguments of ``__exit__`` will be ``None``
5959
except after errors. You should be safe to ignore them, and just include
6060
code that will close down your hardware, which is equivalent to a
6161
``finally:`` block.
62-
* Properties and Actions are defined using decorators: the :deco:`.thing_action`
62+
* Properties and Actions are defined using decorators: the :deco:`.thing_action`
6363
decorator declares a method to be an action, which will run when it's triggered,
6464
and the :deco:`.property` decorator does the same for a property.
6565
6666
Properties may also be defined using dataclass-style syntax, if they do
6767
not need getter and setter functions.
6868
6969
See the documentation on those functions for more detail.
70-
* `title` will be used in various places as the human-readable name of your Thing,
70+
* `title` will be used in various places as the human-readable name of your Thing,
7171
so it makes sense to set this in a subclass.
7272
7373
There are various LabThings methods that you should avoid overriding unless you

0 commit comments

Comments
 (0)