Skip to content

Docstring improvements to "Unpack" method #133

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

Open
Druthyn wants to merge 1 commit into
base: docs-improvements
Choose a base branch
from
Open

Docstring improvements to "Unpack" method #133

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion src/spacepackets/ccsds/spacepacket.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,12 @@ def packet_len(self) -> int:
def unpack(cls, data: bytes | bytearray) -> SpacePacketHeader:
"""Unpack a raw space packet into the space packet header instance.

:raise ValueError: Raw packet length invalid
Raises
-------
BytesTooShortError
Raw packet is too short to contain a CCSDS Header
ValueError
Raw packet length invalid
"""
if len(data) < SPACE_PACKET_HEADER_SIZE:
raise BytesTooShortError(SPACE_PACKET_HEADER_SIZE, len(data))
Expand Down