Add docstrings to all public package
This commit is contained in:
parent
14359e73bb
commit
864ca91e5c
7 changed files with 46 additions and 1 deletions
|
|
@ -0,0 +1,5 @@
|
|||
"""A package for all of the core LabThings-FastAPI Things shipped with the microscope.
|
||||
|
||||
The microscope can be extended to be used with other hardware by creating a package
|
||||
with other Things and including them in the LabThings-FastAPI config file.
|
||||
"""
|
||||
|
|
@ -1,3 +1,14 @@
|
|||
"""A package for stage control Things.
|
||||
|
||||
`BaseStage` is the base class that provides core stage functionality, but
|
||||
no hardware interface control. To create a stage Thing to control a specific
|
||||
piece of hardware the BaseStage should be subclassed, and any method raising
|
||||
a NotImplementedError should be created.
|
||||
|
||||
As the object will be used as a context manager create the hardware connection in
|
||||
``__enter__`` (not in ``__init__``), and close the connection with ``__exit__``.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
from collections.abc import Sequence, Mapping
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue