Skip to content

Commit

Permalink
update docstring for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
vmartinez-cu committed Nov 22, 2024
1 parent adfb891 commit f619249
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions imap_processing/hit/l0/decom_hit.py
Original file line number Diff line number Diff line change
Expand Up @@ -389,15 +389,14 @@ def decompress_rates_16_to_32(packed: int) -> int:
"""
Will decompress rates data from 16 bits to 32 bits.
This function decompresses the rates data from the binary
format to integers. The compressed integer (packed) combines
This function decompresses the rates data from 16-bit integers
to 32-bit integers. The compressed integer (packed) combines
two parts:
1. Mantissa: Represents the significant digits of the value.
2. Exponent: Determines how much to scale the mantissa (using powers of 2).
These parts are packed together into a single 16-bit integer.
Numbers up to 212 are uncompressed.
Parameters
----------
Expand Down

0 comments on commit f619249

Please sign in to comment.