Skip to content
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

Add a warning to schedule docs #70

Merged
merged 2 commits into from
Feb 3, 2025
Merged

Add a warning to schedule docs #70

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a41954
Add a warning to schedule docs
spacey-sooty Sep 13, 2024
b97310f
Update commandscheduler.py
spacey-sooty Jan 29, 2025
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
3 changes: 3 additions & 0 deletions commands2/commandscheduler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,9 @@ def schedule(self, *commands: Command) -> None:
using those requirements have been scheduled as interruptible. If this is the case, they will
be interrupted and the command will be scheduled.

WARNING: using this function directly can often lead to unexpected behavior and should be
avoided. Instead Triggers should be used to schedule Commands.

:param commands: the commands to schedule.
"""
for command in commands:
Expand Down