Add module level docstrings.

This commit is contained in:
Julian Stirling 2025-07-10 08:59:27 +01:00
parent 80beeea07b
commit 2cb4003835
17 changed files with 70 additions and 2 deletions

View file

@ -1,3 +1,12 @@
"""The core sample scanning functionality for the OpenFlexure Microscope.
SmartScan provides sample scanning functionality including automatic background
dectection (via the `BackgroundDetectThing`) and automatic path planning via
`scan_planners`. It manages the directories of past scans via `scan_directories`.
It also controls external processes for live stitching composite images, and
the creation of the final stitched images.
"""
from typing import Optional, Mapping
import threading
import os