Add punctuation to docstrings
This commit is contained in:
parent
4dc41bb008
commit
80beeea07b
34 changed files with 232 additions and 235 deletions
|
|
@ -41,14 +41,14 @@ SCAN_DIR = os.path.join(tempfile.gettempdir(), "scans")
|
|||
|
||||
|
||||
def _clear_scan_dir() -> None:
|
||||
"""Delete the scan dir"""
|
||||
"""Delete the scan dir."""
|
||||
if os.path.exists(SCAN_DIR):
|
||||
shutil.rmtree(SCAN_DIR)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def smart_scan_thing():
|
||||
"""Return a smart scan thing as a fixture"""
|
||||
"""Return a smart scan thing as a fixture."""
|
||||
return SmartScanThing(SCAN_DIR)
|
||||
|
||||
|
||||
|
|
@ -75,7 +75,7 @@ def test_inaccessible_scan_methods(smart_scan_thing):
|
|||
|
||||
|
||||
def test_private_delete_scan(smart_scan_thing, caplog):
|
||||
"""Test the private _delete_scan method deletes directories or warns if it can't"""
|
||||
"""Test the private _delete_scan method deletes directories or warns if it can't."""
|
||||
_clear_scan_dir()
|
||||
with caplog.at_level(logging.INFO):
|
||||
fake_scan_name = "fake_scan_0001"
|
||||
|
|
@ -101,7 +101,7 @@ def test_private_delete_scan(smart_scan_thing, caplog):
|
|||
|
||||
|
||||
def test_public_delete_scan(smart_scan_thing, caplog):
|
||||
"""Test the delete_scan API call deletes directories or warns if it can't"""
|
||||
"""Test the delete_scan API call deletes directories or warns if it can't."""
|
||||
_clear_scan_dir()
|
||||
with caplog.at_level(logging.INFO):
|
||||
fake_scan_name = "fake_scan_0001"
|
||||
|
|
@ -152,7 +152,7 @@ def test_delete_all_scans(smart_scan_thing, caplog):
|
|||
|
||||
|
||||
def _run_only_outer_scan(adjust_inital_state: Optional[Callable] = None):
|
||||
"""Create a subclass of SmartScanThing to mock _run_scan and run sample_scan
|
||||
"""Create a subclass of SmartScanThing to mock _run_scan and run sample_scan.
|
||||
|
||||
This should do all the set up for a scan, move into the mocked
|
||||
_run_scan method where this can be tested. Once this is done
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue