Skip to content

Commit

Permalink
Docstring, variable name, formatting updates to IDEX L1 (IMAP-Science…
Browse files Browse the repository at this point in the history
…-Operations-Center#799)

* Various updates to docstrings, variable names, formatting
* Moved pytest fixture that returns test data to conftest.py
  • Loading branch information
bourque authored and laspsandoval committed Sep 4, 2024
1 parent 06e1d0b commit 5545f4b
Show file tree
Hide file tree
Showing 6 changed files with 251 additions and 201 deletions.
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@
(r"py:.*", r".*numpy.int.*"),
(r"py:.*", r".*np.ndarray.*"),
(r"py:.*", r".*numpy._typing._array_like._ScalarType_co.*"),
(r"py:.*", r".*idex.l1.TRIGGER_DESCRIPTION.*"),
]

# Ignore the inherited members from the <instrument>APID IntEnum class
Expand Down
6 changes: 4 additions & 2 deletions imap_processing/idex/l0/idex_l0.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
"""Decommutate IDEX CCSDS packets."""

import logging
from pathlib import Path
from typing import Union

from imap_processing import decom, imap_module_directory

logger = logging.getLogger(__name__)


def decom_packets(packet_file: str) -> list:
def decom_packets(packet_file: Union[str, Path]) -> list:
"""
Decom IDEX data packets using IDEX packet definition.
Parameters
----------
packet_file : str
packet_file : pathlib.Path | str
String to data packet path with filename.
Returns
Expand Down
Loading

0 comments on commit 5545f4b

Please sign in to comment.