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,13 @@
"""Test the server without creating a full HTTP server and socket connection.
Rather than spinning up a full uvicorn webserver for each test these tests use
the FastAPI ``TestClient`` or to directly communicate with the underlying
LabThings-FastAPI code. This increases speed of testing significantly.
For tests that require a full running server see the ``integration-tests``
directory in the root of the repository.
"""
import json
import os
import tempfile

View file

@ -1,3 +1,5 @@
"""Test the functionality in the scan_directories module."""
import tempfile
import os
import math

View file

@ -1,3 +1,9 @@
"""Test the scan planning algorithms of the Microscope.
As well as low level function by function tests, this test suite also provides tests
that simulate scanning a sample, checking that the expected path is followed.
"""
import pytest
from copy import copy

View file

@ -1,3 +1,9 @@
"""Utility functions for testing scan planners.
These including fake sample creation, scan path visualisation, and
persistent storage of expected scan paths for samples.
"""
import os
import pickle