Skip to content

Commit c48ebb7

Browse files
committed
add docstring for combine gnss_sv_id
1 parent 1b50238 commit c48ebb7

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

gnss_lib_py/utils/sv_models.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,13 @@ def _combine_gnss_sv_ids(measurement_frame):
352352
measurement_frame : gnss_lib_py.parsers.navdata.NavData
353353
NavData instance containing measurements including `gnss_id` and
354354
`sv_id`.
355+
356+
Returns
357+
-------
358+
gnss_sv_id : np.ndarray
359+
New row values that combine `gnss_id` and `sv_id` into a something
360+
similar to 'R01' or 'G12' for example.
361+
355362
"""
356363
constellation_char_inv = {const : gnss_char for gnss_char, const in consts.CONSTELLATION_CHARS.items()}
357364
gnss_chars = [constellation_char_inv[const] for const in measurement_frame['gnss_id']]

0 commit comments

Comments
 (0)