docs: add remove breaks documentation

1 files changed, 15 insertions, 0 deletions

diff --git a/doc/user/transformers.rst b/doc/user/transformers.rst
index c8ddf01..d053052 100644
--- a/doc/user/transformers.rst
+++ b/doc/user/transformers.rst
@@ -43,3 +43,18 @@ point.
 
 To fix those points, the transformer will find the first correct point, and
 copy its elevation to the wrong points.
+
+Remove Breaks
+-------------
+
+The *remove breaks* transformer removes longer breaks of inactivity by deleting
+the points and shifting the following points back in time. This is useful e.g.
+if you are waiting at a single spot for a while, and you would like that to be
+removed for a cleaner log.
+
+Note that this transformer modifies the track's timings. Therefore, the
+recording will end earlier than it did in reality, and the stopped time will be
+reduced.
+
+A break is removed if the speed is below 1 kilometer per hour (approx. 0.28
+meters per second) for more than 5 minutes.