Skip to content

Commit c5afda1

Browse files
author
Naragod
committed
ISSUE-662: Update function docs
1 parent cf045c6 commit c5afda1

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

server/autotest_server/testers/tester.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ def format_result(
6060
points when assigning bonus points).
6161
:param points_total: The total points the test could earn, must be a float >= 0.
6262
:param time: The time it took to run the test, can be None
63+
:param extra_properties: adds useful information to the test result.
6364
:return The formatted test result.
6465
"""
6566
if points_total < 0:
@@ -90,6 +91,7 @@ def format(self, status: str, output: str, points_earned: int, extra_properties:
9091
:param output: The test output.
9192
:param points_earned: The points earned by the test, must be a float >= 0 (can be greater than the test total
9293
points when assigning bonus points).
94+
:param extra_properties: adds useful information to the test result.
9395
:return The formatted test result.
9496
"""
9597
return Test.format_result(
@@ -141,6 +143,7 @@ def passed_with_bonus(self, points_bonus: int, message: str = "", extra_properti
141143
feedback to it.
142144
:param points_bonus: The bonus points, must be an int >= 0.
143145
:param message: An optional message, will be shown as test output.
146+
:param extra_properties: adds useful information to the test result.
144147
:return The formatted passed test.
145148
"""
146149
if points_bonus < 0:
@@ -157,6 +160,7 @@ def passed(self, message: str = "", extra_properties: Dict = {}) -> str:
157160
"""
158161
Passes this test earning the test total points. If a feedback file is enabled, adds feedback to it.
159162
:param message: An optional message, will be shown as test output.
163+
:param extra_properties: adds useful information to the test result.
160164
:return The formatted passed test.
161165
"""
162166
result = self.format(
@@ -169,7 +173,7 @@ def partially_passed(self, points_earned: int, message: str, extra_properties: D
169173
Partially passes this test with some points earned. If a feedback file is enabled, adds feedback to it.
170174
:param points_earned: The points earned by the test, must be an int > 0 and < the test total points.
171175
:param message: The message explaining why the test was not fully passed, will be shown as test output.
172-
:param message: Extra properties returned, useful to the test result.
176+
:param extra_properties: adds useful information to the test result.
173177
:return The formatted partially passed test.
174178
"""
175179
if points_earned <= 0:
@@ -185,6 +189,7 @@ def failed(self, message: str, extra_properties: Dict = {}) -> str:
185189
"""
186190
Fails this test with 0 points earned. If a feedback file is enabled, adds feedback to it.
187191
:param message: The failure message, will be shown as test output.
192+
:param extra_properties: adds useful information to the test result.
188193
:return The formatted failed test.
189194
"""
190195
result = self.format(
@@ -216,6 +221,7 @@ def error(self, message: str, extra_properties: Dict = {}) -> str:
216221
"""
217222
Err this test. If a feedback file is enabled, adds feedback to it.
218223
:param message: The error message, will be shown as test output.
224+
:param extra_properties: adds useful information to the test result.
219225
:return The formatted erred test.
220226
"""
221227
result = self.format(

0 commit comments

Comments
 (0)