From 9455a94ee81a574b02804f3c5903680966a7c18f Mon Sep 17 00:00:00 2001
From: kienle <kienle@passcal.nmt.edu>
Date: Thu, 24 Aug 2023 13:46:32 -0600
Subject: [PATCH] Add documentation
---
sohstationviewer/model/reftek/reftek_data/header.py | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/sohstationviewer/model/reftek/reftek_data/header.py b/sohstationviewer/model/reftek/reftek_data/header.py
index 44522b016..a63685b1f 100644
--- a/sohstationviewer/model/reftek/reftek_data/header.py
+++ b/sohstationviewer/model/reftek/reftek_data/header.py
@@ -55,6 +55,12 @@ def parse_rt130_time(year: int, time_bytes: bytes) -> UTCDateTime:
def get_rt130_packet_header(rt130_packet: bytes) -> PacketHeader:
+ """
+ Get the packet header stored in the first 16 bits of an RT130 packet.
+
+ :param rt130_packet: the RT130 packet to process
+ :return: a PacketHeader object containing the header of rt130_packet
+ """
try:
# Because RT130 data is always big-endian, it is more convenient to
# use str.decode() than the unpacker.
--
GitLab