From 0ce54d0e42f0ebef4f4610c1883da09094743eb0 Mon Sep 17 00:00:00 2001 From: Koen Vossen Date: Mon, 28 Dec 2020 14:20:40 +0100 Subject: [PATCH] minor --- docs/api/domain/event.md | 1 + kloppy/domain/models/common.py | 8 ++++---- kloppy/domain/models/event.py | 8 ++++---- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/api/domain/event.md b/docs/api/domain/event.md index 2bb74edc..0cb18dc6 100644 --- a/docs/api/domain/event.md +++ b/docs/api/domain/event.md @@ -12,6 +12,7 @@ ## Events ### Event base class + ::: kloppy.domain.models.event.Event ::: kloppy.domain.models.event.ShotEvent diff --git a/kloppy/domain/models/common.py b/kloppy/domain/models/common.py index b3e74076..43f92c93 100644 --- a/kloppy/domain/models/common.py +++ b/kloppy/domain/models/common.py @@ -305,10 +305,10 @@ class DataRecord(ABC): DataRecord Attributes: - period (Period): - timestamp (float): - ball_owning_team (Team): - ball_state (BallState): + period: See [`Period`][kloppy.domain.models.common.Period] + timestamp: Timestamp of occurrence + ball_owning_team: See [`Team`][kloppy.domain.models.common.Team] + ball_state: See [`Team`][kloppy.domain.models.common.BallState] """ period: Period diff --git a/kloppy/domain/models/event.py b/kloppy/domain/models/event.py index 6ed48ea0..413c7ae7 100644 --- a/kloppy/domain/models/event.py +++ b/kloppy/domain/models/event.py @@ -297,13 +297,13 @@ class CounterAttackQualifier(BoolQualifier): @docstring_inherit_attributes(DataRecord) class Event(DataRecord, ABC): """ - Event + Abstract event baseclass. All other event classes inherit from this class. Attributes: - event_id: str - team: Team + event_id: identifier given by provider + team: See [`Team`][kloppy.domain.models.common.Team] player: See [`Player`][kloppy.domain.models.common.Player] - coordinates: Point + coordinates: Coordinates where event happened. See [`Point`][kloppy.domain.models.pitch.Point] raw_event: Dict state: Dict[str, Any] qualifiers: See [`Qualifier`][kloppy.domain.models.event.Qualifier]