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 documentation for Scheduler.start() #2

Closed
wants to merge 2 commits into from
Closed

Add documentation for Scheduler.start() #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e49d17
Update scheduler.md
slurpyb Dec 16, 2024
847c3fa
Merge pull request #1 from slurpyb/slurpyb-patch-1
slurpyb Dec 16, 2024
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 docs/reference/scheduler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ Provides a class that schedules events after a certain amount of time.
<span class="docs">Creates a scheduler. All events are canceled when the context manager exits.</span>

## Scheduler
<code>**def start**() -> None</code><br>
<span class="docs">Begins executing scheduled events. Call this after `schedule()` or `repeat()`.</span>

<code>**def schedule**(function: Callable, delay: float, \*args) -> int</code><br>
<span class="docs">Schedules an asynchronous function call after `delay` seconds. Returns a handle that can be passed to `remove()`.</span>

Expand Down