Single line summaries of docstrings

This commit is contained in:
Julian Stirling 2025-07-10 01:58:14 +01:00
parent 35d47fe3ed
commit 4dc41bb008
20 changed files with 153 additions and 115 deletions

View file

@ -222,8 +222,10 @@ def test_mark_wrong_location():
def test_closest_focus_wth_large_numbers():
"""The number of steps gets very large in reality runs some tests to check
that everything works well with huge numbers of steps
"""Tests to check that everything works well with huge numbers of steps.
The number of steps gets very large on the micorscope. But most of the tests
above use smaller numbers for clarity.
"""
intial_position = (0, 0)
# Set this up, but we won't use the settings
@ -247,11 +249,18 @@ def test_closest_focus_wth_large_numbers():
def test_example_smart_spiral():
"""Test the smart spiral scan algorithm on the sample types listed
below and defined in scan_test_helpers.load_sample_points
"""Test the smart spiral scan algorithm on the different sample types.
Will fail if the locations or path between locations visited has changed
for any of the samples listed
The sample types:
* ``regular``
* ``lobed``
* ``core"``
These are defined in scan_test_helpers.load_sample_points
This will fail if the locations or path between locations visited has changed
for any of the samples listed.
"""
example_samples = [
"regular",