From: Jiri Vlasak <jiri.vlasak.2@cvut.cz>
Date: Wed, 8 Mar 2023 09:42:10 +0000 (+0100)
Subject: Improve docstring
X-Git-Url: https://rtime.felk.cvut.cz/gitweb/hubacji1/path-to-traj.git/commitdiff_plain/872505fd5cf9ec38f6f51de8d52d27d324523181

Improve docstring
---

diff --git a/path-to-traj.py b/path-to-traj.py
index 6bea9c0..18f6522 100755
--- a/path-to-traj.py
+++ b/path-to-traj.py
@@ -1,5 +1,13 @@
 #!/usr/bin/env python3
-"""Translate equidistant path to equitemporal (isochronic) trajectory."""
+"""Translate equidistant path to equitemporal (isochronic) trajectory.
+
+Path does not need to be equidistant, in fact. Typically, the last point
+of the path segment is closer due to interpolation.
+
+It is expected that the point of the path has five values: x, y,
+heading, speed, and type, where type is +1 for left turn, -1 for right
+turn, and 0 for straight segment.
+"""
 from math import sin, atan, cos, tan, pi, acos
 import json