Documentation minor fixes (#45)

Author: Adakar

docs/index.md

@@ -15,14 +15,14 @@ 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/)  

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
@@ -251,9 +252,11 @@ def enable_loglevel_in_test_module() -> None:
 def section(title: str, description: str = "") -> None:
     """Allows using Squish's sections as context managers
     https://doc.qt.io/squish/squish-api.html#test-startsection-function
+
     Args:
         title (str): Section title
         description (str): Optional additional description of the section
+
     Examples:
         ```python
         with section("Add new person"):

squape/squishserver.py

@@ -178,6 +178,7 @@ def attachToApplication(self, aut: str):
 
         Args:
             aut (str): the name of the attachable AUT
+
         Returns:
             (ApplicationContext): application context
         """
@@ -191,6 +192,7 @@ def startApplication(self, aut: str):
 
         Args:
             aut (str): the name of the mapped AUT
+
         Returns:
             (ApplicationContext): application context
         """

squape/video.py

@@ -95,6 +95,7 @@ def video_capture(message: str = "", remove_on_success: bool = False) -> None:
     !!! warning
         Removing videos on success does not work with Squish 7.1.1 and below
         when execution is triggered outside the Squish IDE.
+
     Args:
         message (str): log a video n the test report using the specified message.
             Defaulting to empty string.

squape/vps.py

@@ -18,7 +18,7 @@
 def vph_property(
     object_or_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.
 
@@ -27,6 +27,7 @@ def vph_property(
         property_name (str): name of the property to verify
         expected_value (any): expected value of the verified property
         msg (str): verification message
+
     Returns:
         True if verification is positive, False otherwise
     """