Skip to content

Commit

Permalink
More docstring formatting fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Adakar committed Sep 17, 2023
1 parent 892e6a8 commit 59254b3
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions squape/report.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"):
Expand Down
2 changes: 2 additions & 0 deletions squape/squishserver.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@ def attachToApplication(self, aut: str):
Args:
aut (str): the name of the attachable AUT
Returns:
(ApplicationContext): application context
"""
Expand All @@ -191,6 +192,7 @@ def startApplication(self, aut: str):
Args:
aut (str): the name of the mapped AUT
Returns:
(ApplicationContext): application context
"""
Expand Down
1 change: 1 addition & 0 deletions squape/video.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions squape/vps.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""
Expand Down

0 comments on commit 59254b3

Please sign in to comment.