add docstrings to models/track.py

1 files changed, 12 insertions, 0 deletions

diff --git a/fietsboek/models/track.py b/fietsboek/models/track.py
index 0162f39..ed20a07 100644
--- a/fietsboek/models/track.py
+++ b/fietsboek/models/track.py
@@ -153,6 +153,12 @@ track_favourite_assoc = Table(
 
 
 class Waypoint(Base):
+    """A waypoint represents a "point of interest" along a path.
+
+    Waypoints can have a name and description set. They exist outside of the
+    actual route.
+    """
+    # pylint: disable=too-few-public-methods
     __tablename__ = "waypoints"
     id = Column(Integer, primary_key=True)
     track_id = Column(Integer, ForeignKey("tracks.id"), nullable=False)
@@ -166,6 +172,8 @@ class Waypoint(Base):
 
 
 class TrackPoint(Base):
+    """A track point represents a single GPS point along a path."""
+    # pylint: disable=too-few-public-methods
     __tablename__ = "track_points"
     track_id = Column(Integer, ForeignKey("tracks.id"), primary_key=True)
     index = Column(Integer, primary_key=True)
@@ -177,6 +185,10 @@ class TrackPoint(Base):
     track: Mapped["Track"] = relationship("Track", back_populates="points")
 
     def to_geo_point(self) -> geo.Point:
+        """Converts this point (a database object) to a plain point.
+
+        :return: The converted point.
+        """
         return geo.Point(
             latitude=self.latitude,
             longitude=self.longitude,