Skip to content

Commit

Permalink
DOC: link to event schedule data info from class docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
theOehrly committed Oct 19, 2023
1 parent 871f013 commit f556a9c
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions fastf1/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -736,6 +736,9 @@ def _get_schedule_from_ergast(year) -> "EventSchedule":
class EventSchedule(pd.DataFrame):
"""This class implements a per-season event schedule.
For detailed information about the information that is available for each
event, see `Event Schedule Data`_.
This class is usually not instantiated directly. You should use
:func:`fastf1.get_event_schedule` to get an event schedule for a specific
season.
Expand Down Expand Up @@ -934,6 +937,9 @@ class Event(pd.Series):
Each event consists of one or multiple sessions, depending on the type
of event and depending on the event format.
For detailed information about the information that is available for each
event, see `Event Schedule Data`_.
This class is usually not instantiated directly. You should use
:func:`fastf1.get_event` or similar to get a specific event.
Expand Down

0 comments on commit f556a9c

Please sign in to comment.