Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docstring, variable name, formatting updates to IDEX L1 #799

Merged
merged 6 commits into from
Sep 3, 2024
Merged

Docstring, variable name, formatting updates to IDEX L1 #799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7a0956e
Various updates to docstrings, variable names, formatting
bourque Aug 29, 2024
cd68d37
Fixed typo
bourque Aug 29, 2024
32c22d9
Attempting to fix doc build
bourque Aug 29, 2024
16327d5
Attempting to fix mypy errors
bourque Aug 29, 2024
15af12b
Attempting to fix doc build
bourque Aug 29, 2024
393db0b
Moved pytest fixture that returns test data to conftest.py
bourque Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/conf.py
View file
Open in desktop
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
View file
Open in desktop
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
Loading