diff options
| author | Alex Grönholm <alex.gronholm@nextday.fi> | 2022-08-16 00:47:44 +0300 |
|---|---|---|
| committer | Alex Grönholm <alex.gronholm@nextday.fi> | 2022-08-16 01:17:45 +0300 |
| commit | 6371198f4df8557751b968235c583191f243abe2 (patch) | |
| tree | 892e2541dc7e130e96f9fe6be7671401988af470 /docs | |
| parent | 23bf672fd0f74a76a966c9fda2468a707ab250be (diff) | |
| download | apscheduler-6371198f4df8557751b968235c583191f243abe2.tar.gz | |
Improved the documentation of the enumerated types
The values did not show up in the documentation before this.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/docs/api.rst b/docs/api.rst index f6c1fd5..15461ee 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -92,9 +92,17 @@ Enumerated types Context variables ----------------- -.. autodata:: apscheduler.current_scheduler -.. autodata:: apscheduler.current_worker -.. autodata:: apscheduler.current_job +See the :mod:`contextvars` module for information on how to work with context variables. + +.. data:: apscheduler.current_scheduler + :annotation: the current scheduler + :type: ~contextvars.ContextVar[~typing.Union[Scheduler, AsyncScheduler]] +.. data:: apscheduler.current_worker + :annotation: the current scheduler + :type: ~contextvars.ContextVar[~typing.Union[Worker, AsyncWorker]] +.. data:: apscheduler.current_job + :annotation: information on the job being currently run + :type: ~contextvars.ContextVar[JobInfo] Exceptions ---------- |