Merge branch 'more-docs'

PySport · Dec 28, 2020 · 3a95853 · 3a95853
2 parents 2c4ce19 + 0ce54d0
commit 3a95853
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git 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
@@ -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
@@ -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]