Skip to content

Commit 0fbfae5

Browse files
committed
NPI-4067 clean up docstring based on PR feedback
1 parent a72a39c commit 0fbfae5

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

gnssanalysis/gn_io/sp3.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -525,14 +525,13 @@ def _check_column_alignment_of_sp3_block(
525525
ignore_short_data_lines: bool = True,
526526
) -> None:
527527
"""
528-
Check an indivual SP3 block (one epoch), for line length and column alignment
528+
Check an individual SP3 block (one epoch), for line length and column alignment
529529
:param str date: Epoch start date/time, typically beginning with '*'
530530
:param str data: Entries for the given epoch (multiple rows, not yet split on '\n')
531-
:param type[StrictMode] strict_mode: (default: WARN) how to respond to issues found. No check / warning / exception.
532-
:param bool ignore_short_data_lines: (default True) don't fail the check due to data lines which are < 80 chars,
533-
even though this is technically not to spec under SP3 version d.
534-
# :returns bool: True if the block passes validation. False otherwise (along with logging a warning), unless an
535-
# exception is raised.
531+
:param type[StrictMode] strict_mode: Determines response to issues found. Ignore or don't run check / warning /
532+
raise exception. Defaults to WARN.
533+
:param bool ignore_short_data_lines: don't fail the check due to data lines which are < 80 chars,
534+
even though this is technically not to spec under SP3 version d. Defaults to True.
536535
:raises ValueError: if validation doesn't pass, and strict_mode is set to STRICT_RAISE.
537536
"""
538537
# Check epoch header (date) and data lines (P/V/EP/EV) are the right length, and that all unused columns (by SP3d

0 commit comments

Comments
 (0)