Skip to content

Fix ChoreTask docstring: step is 0-based positional, not "1 to n" #1487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MariusWirtz merged 1 commit into from
Oct 14, 2026
Merged

Fix ChoreTask docstring: step is 0-based positional, not "1 to n" #1487

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions TM1py/Objects/ChoreTask.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
class ChoreTask(TM1Object):
"""Abstraction of a Chore Task

A Chore task always conistst of
- The step integer ID: it's order in the execution plan.
1 to n, where n is the last Process in the Chore
A Chore task always consists of
- The step integer ID: its order in the execution plan.
0-based: 0 to n-1, where n is the number of Processes in the Chore
- The name of the process to execute
- The parameters for the process

Expand All @@ -22,7 +22,7 @@ class ChoreTask(TM1Object):
def __init__(self, step: int, process_name: str, parameters: List[Dict[str, str]]):
"""

:param step: step in the execution order of the Chores' processes. 1 to n, where n the number of processes
:param step: step in the execution order of the Chore's processes. 0-based: 0 to n-1, where n is the number of processes
:param process_name: name of the process
:param parameters: list of dictionaries with 'Name' and 'Value' property:
[{
Expand Down
Loading