From f556a9ce46b6fe26a8a48ad3c54e8f98075b1396 Mon Sep 17 00:00:00 2001 From: theOehrly <23384863+theOehrly@users.noreply.github.com> Date: Thu, 19 Oct 2023 14:32:41 +0200 Subject: [PATCH] DOC: link to event schedule data info from class docstrings --- fastf1/events.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/fastf1/events.py b/fastf1/events.py index 90f8e19b1..042bb7962 100644 --- a/fastf1/events.py +++ b/fastf1/events.py @@ -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. @@ -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.