Skip to content

Commit 1fbe423

Browse files
committed
NPI-3945 better docstring
1 parent 909ae89 commit 1fbe423

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

gnssanalysis/gn_datetime.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,10 @@ def __str__(self) -> str:
162162

163163
def datetime_to_gps_week(dt: _datetime, wkday_suff: bool = False) -> str:
164164
"""
165-
Convert the given datetime object to a GPS week (option to include day suffix)
165+
Convert given datetime object to GPS week e.g. '2350', optionally including day suffix e.g. '23500' (Sunday)
166+
167+
:param datetime dt: datetime for which to calculate a GPS week (and optionally day)
168+
:returns str: intput datetime expressed as a GPS week (wwww) or GPS week with day (wwwwd)
166169
"""
167170
yr = dt.strftime("%Y")
168171
doy = dt.strftime("%j")

0 commit comments

Comments
 (0)