rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add punctuation to docstrings

Browse source
This commit is contained in:
Julian Stirling 2025-07-10 02:03:02 +01:00
parent 4dc41bb008
commit 80beeea07b
34 changed files with 232 additions and 235 deletions
Download patch file Download diff file Expand all files Collapse all files

2
tests/utilities/__init__.py
View file

@ -9,7 +9,7 @@ from collections.abc import Hashable
class SizedIterableHashable(Iterable[Hashable], Protocol):
"""A protocol for sized iterable of hashable objects"""
"""A protocol for sized iterable of hashable objects."""
def __len__(self) -> int:
"""Add a len function to protocol so Python knows the object is sized."""

6
tests/utilities/scan_test_helpers.py
View file

@ -44,14 +44,14 @@ class FakeSample:
@property
def patch(self) -> PathPatch:
"""The sample as a matplotlib patch for plotting"""
"""The sample as a matplotlib patch for plotting."""
patch = PathPatch(self._sample_perimeter)
patch.set(color=(1.0, 0.8, 1.0, 1.0))
return patch
def visualise_scan(sample: FakeSample, planner: scan_planners.ScanPlanner) -> Figure:
"""For a given sample and scanner object return a matplotlib figure of the scan"""
"""For a given sample and scanner object return a matplotlib figure of the scan."""
fig, ax = plt.subplots(figsize=(8, 8))
ax.add_artist(sample.patch)
xh, yh = zip(*planner._path_history)
@ -184,7 +184,7 @@ def get_expected_result_for_example_smart_spiral(
def load_sample_points(sample_name: str):
"""Return the points to generate the FakeSample corresponding to the given input name
"""Return the points to generate the FakeSample corresponding to the given input name.
Options are "lobed", "regular", and "core".
"""