From e0a28fd9c3bf9849eb6c177955d2959eb36b5829 Mon Sep 17 00:00:00 2001 From: Daniel da Silva Date: Tue, 13 Feb 2024 01:23:55 -0500 Subject: [PATCH] Add primary header field names to include_primary_header=True doc --- ccsdspy/packet_types.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/ccsdspy/packet_types.py b/ccsdspy/packet_types.py index 810fb6b..242bbce 100644 --- 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 -------