Skip to content

Commit

Permalink
Update airflow/timetables/base.py
Browse files Browse the repository at this point in the history
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
  • Loading branch information
pateash and uranusjr authored Oct 24, 2021
1 parent 414ab33 commit 6786866
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions airflow/timetables/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,10 @@ class Timetable(Protocol):
"""Protocol that all Timetable classes are expected to implement."""

description: Optional[str] = None
"""Describes the timetable interval,
eg. for CronDataIntervalTimetable ``'30 21 * * 5'``,
description could be like ``'At 21:30, only on Friday'``, This is used in the webserver UI.
"""Human-readable description of the timetable.
For example, this can produce something like ``'At 21:30, only on Friday'``
from the cron expression ``'30 21 * * 5'``. This is used in the webserver UI.
"""

periodic: bool = True
Expand Down

0 comments on commit 6786866

Please sign in to comment.