Merge branch 'main' into complex-byte-order

CCSDSPy · Feb 13, 2024 · 31a24ca · 31a24ca
2 parents e7e5b3c + e0a28fd
commit 31a24ca
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/ccsdspy/packet_types.py b/ccsdspy/packet_types.py
@@ -149,7 +149,10 @@ def load(self, file, include_primary_header=False):
         file : str
            Path to file on the local file system, or file-like object
         include_primary_header : bool
-           If True, provides the primary header in the output
+           If True, provides the primary header in the output. The names of the
+           fields are: `CCSDS_VERSION_NUMBER`, `CCSDS_PACKET_TYPE`, 
+           `CCSDS_SECONDARY_FLAG`, `CCSDS_SEQUENCE_FLAG`, `CCSDS_APID`, 
+           `CCSDS_SEQUENCE_COUNT`, and `CCSDS_PACKET_LENGTH`
 
         Returns
         -------
@@ -267,7 +270,10 @@ def load(self, file, include_primary_header=False):
         file : str
            Path to file on the local file system, or file-like object
         include_primary_header : bool
-           If True, provides the primary header in the output
+           If True, provides the primary header in the output. The names of the
+           fields are: `CCSDS_VERSION_NUMBER`, `CCSDS_PACKET_TYPE`, 
+           `CCSDS_SECONDARY_FLAG`, `CCSDS_SEQUENCE_FLAG`, `CCSDS_APID`, 
+           `CCSDS_SEQUENCE_COUNT`, and `CCSDS_PACKET_LENGTH`
 
         Returns
         -------