diff --git a/squape/report.py b/squape/report.py index 4b606cc..d6c74fb 100644 --- a/squape/report.py +++ b/squape/report.py @@ -252,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"): diff --git a/squape/squishserver.py b/squape/squishserver.py index 8f1f100..c1b62f1 100644 --- a/squape/squishserver.py +++ b/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 """ diff --git a/squape/video.py b/squape/video.py index 678cf78..7d80087 100644 --- a/squape/video.py +++ b/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. diff --git a/squape/vps.py b/squape/vps.py index 87f2862..4d55dd1 100644 --- a/squape/vps.py +++ b/squape/vps.py @@ -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 """