aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThéo de la Hogue2023-08-09 18:43:29 +0200
committerThéo de la Hogue2023-08-09 18:43:29 +0200
commit8afe6d3a501f895849da3290a706f9ac3418b0d6 (patch)
tree9b7a788d44be844ffe9fa6973fa3ecab6cbc2eb0
parent8ef66affb995c5ef23f29ad567acff33a77b0d0e (diff)
downloadargaze-8afe6d3a501f895849da3290a706f9ac3418b0d6.zip
argaze-8afe6d3a501f895849da3290a706f9ac3418b0d6.tar.gz
argaze-8afe6d3a501f895849da3290a706f9ac3418b0d6.tar.bz2
argaze-8afe6d3a501f895849da3290a706f9ac3418b0d6.tar.xz
Adding duration_max documentation.
-rw-r--r--src/argaze/GazeFeatures.py6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/argaze/GazeFeatures.py b/src/argaze/GazeFeatures.py
index 67e5822..224e2d9 100644
--- a/src/argaze/GazeFeatures.py
+++ b/src/argaze/GazeFeatures.py
@@ -590,7 +590,11 @@ ScanPathType = TypeVar('ScanPathType', bound="ScanPathType")
# Type definition for type annotation convenience
class ScanPath(list):
- """List of scan steps."""
+ """List of scan steps.
+
+ Parameters:
+ duration_max: duration from which older scan steps are removed each time new scan steps are added. 0 means no maximal duration.
+ """
def __init__(self, duration_max: int|float = 0):