From 383d39b1362b9ddd9dd4c5b131fafcc766ee1e83 Mon Sep 17 00:00:00 2001 From: dancergraham Date: Mon, 12 Aug 2024 16:44:48 +0200 Subject: [PATCH] docs: Add a docstring for the ScanHeader class --- src/pye57/scan_header.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/pye57/scan_header.py b/src/pye57/scan_header.py index 1c479bd..908f44b 100644 --- a/src/pye57/scan_header.py +++ b/src/pye57/scan_header.py @@ -5,6 +5,10 @@ from pye57.utils import get_fields, get_node class ScanHeader: + """Provides summary statistics for an individual lidar scan in an E57 file. + + Including the number of points, bounds and pose of the scan. + """ def __init__(self, scan_node): self.node = scan_node points = self.node["points"]