Skip to content

Commit

Permalink
DOC: minor corrections regarding spring shootout
Browse files Browse the repository at this point in the history
  • Loading branch information
theOehrly committed Oct 6, 2023
1 parent 56d84e5 commit b55e78d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
10 changes: 5 additions & 5 deletions fastf1/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -3262,7 +3262,7 @@ class SessionResults(pd.DataFrame):
- ``GridPosition`` | :class:`float` |
The drivers starting position (values only given if session is
'Race', 'Sprint', or 'Sprint Qualifying')
'Race', 'Sprint', 'Sprint Shootout' or 'Sprint Qualifying')
- ``Q1`` | :class:`pd.Timedelta` |
The drivers best Q1 time (values only given if session is
Expand All @@ -3278,15 +3278,15 @@ class SessionResults(pd.DataFrame):
- ``Time`` | :class:`pd.Timedelta` |
The drivers total race time (values only given if session is
'Race', 'Sprint', or 'Sprint Qualifying' and the driver was not
more than one lap behind the leader)
'Race', 'Sprint', 'Sprint Shootout' or 'Sprint Qualifying' and the
driver was not more than one lap behind the leader)
- ``Status`` | :class:`str` |
A status message to indicate if and how the driver finished the race
or to indicate the cause of a DNF. Possible values include but are
not limited to 'Finished', '+ 1 Lap', 'Crash', 'Gearbox', ...
(values only given if session is 'Race', 'Sprint', or
'Sprint Qualifying')
(values only given if session is 'Race', 'Sprint', 'Sprint Shootout'
or 'Sprint Qualifying')
- ``Points`` | :class:`float` |
The number of points received by each driver for their finishing
Expand Down
3 changes: 2 additions & 1 deletion fastf1/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@
Usually, this is the same as the date of the last session.
- ``EventFormat`` | :class:`str` |
The format of the event. One of 'conventional', 'sprint', 'testing'.
The format of the event. One of 'conventional', 'sprint',
'sprint_shootout', 'testing'.
- ``Session*`` | :class:`str` |
The name of the session. One of 'Practice 1', 'Practice 2', 'Practice 3',
Expand Down

0 comments on commit b55e78d

Please sign in to comment.