From 892e6a827a8357b00bc119324c9401113902e268 Mon Sep 17 00:00:00 2001 From: Adakar Date: Sun, 17 Sep 2023 23:10:49 +0200 Subject: [PATCH] Fix minor doc formatting issues --- docs/index.md | 14 +++++++------- squape/report.py | 11 ++++++----- squape/vps.py | 2 +- 3 files changed, 14 insertions(+), 13 deletions(-) diff --git a/docs/index.md b/docs/index.md index 061cdbf..1a0d94e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,13 +15,13 @@ pip install squape ``` ### Content -The package consists of several modules: -- object_tree - seamless object tree navigation and search capabilities -- report - adds features to enhance the reporting capabilities of Squish -- settings - makes using various test settings easier and cleaner -- squishserver - managing squishservers and (un)registering AUTs -- video - adds features to enhance video capture capabilities of Squish -- vps - extension of Squish verification points +The package consists of several modules: +- object_tree - seamless object tree navigation and search capabilities +- report - adds features to enhance the reporting capabilities of Squish +- settings - makes using various test settings easier and cleaner +- squishserver - managing squishservers and (un)registering AUTs +- video - adds features to enhance video capture capabilities of Squish +- vps - extension of Squish verification points ## Contribution The package is created and maintained by [Cyber Alpaca](https://cyberalpaca.com/) diff --git a/squape/report.py b/squape/report.py index 8f97fe6..4b606cc 100644 --- a/squape/report.py +++ b/squape/report.py @@ -231,11 +231,12 @@ def enable_loglevel_in_test_module() -> None: After calling this function, the following 'test' module's functions will support LOGLEVEL report setting: - - test.debug(...) - - test.log(...) - - test.warning(...) - - test.fail(...) - - test.fatal(...) + + - test.debug(...) + - test.log(...) + - test.warning(...) + - test.fail(...) + - test.fatal(...) Returns: None diff --git a/squape/vps.py b/squape/vps.py index 6b2a758..87f2862 100644 --- a/squape/vps.py +++ b/squape/vps.py @@ -18,7 +18,7 @@ def vph_property( object_name: any, property_name: str, expected_value: any, msg: str ) -> bool: - """ "Highlights the object then verifies its property. + """Highlights the object then verifies its property. The object remains highlighted during verification to make it easier to identify on potential screenshots.