Edited docstrings as per convention

Author: kyle-su1

gs/backend/positioning/sgp4_handler.py

@@ -21,7 +21,13 @@
 
 @dataclass
 class SGP4Data:
-    """Data structure representing the satellite's position and velocity."""
+    """
+    Data structure representing the satellite's position and velocity.
+    :param position_km: tuple representing the position of the satellite in km
+    :param velocity_km_sec: tuple representing velocity of the satellite in km/second
+    
+
+    """
 
     position_km: tuple[float, float, float]
     velocity_km_sec: tuple[float, float, float]
@@ -31,6 +37,10 @@ def setup_sgp4(tle: TLEData) -> Satrec:
     """
     Initialize the SGP4 satellite model using TLE data.  Formatting and SGP4 initialization pulled from link below
         https://pypi.org/project/sgp4/
+
+            :warning: currently broken for TLEs where eccentricity is low relative to drag term
+    :param tle(TLEData): The TLE string used to initialize Satrec
+    :return: Returns initialized Satrec
     """
 
 
@@ -94,18 +104,17 @@ def get_sat_position(tle: TLEData, dt: datetime) -> SGP4Data:
     """
     Compute the satellite's position and velocity at a given time.
 
-        Arguments are
-        tle(TLEData): Two-line element set representing the satellite.
-        dt(datetime): The timestamp for which to calculate the position.
-
+        :warning: currently broken for TLEs where eccentricity is low relative to drag term
+        
+    :param tle(TLEData): Two-line element set representing the satellite.
+    :param dt(datetime): The timestamp for which to calculate the position.
+    :return: Returns location data with custom SGP4Data object
     """
+
     sat = setup_sgp4(tle)
     jd, fr = jday(dt.year, dt.month, dt.day, dt.hour, dt.minute, dt.second)
     error_code, position, velocity = sat.sgp4(jd, fr)
 
-    #print("eccentricity (parsed):", tle.eccentricity)
-
-
     if 0.0 <= tle.eccentricity and tle.eccentricity <= 1.0:
         print("tle.eccentricity within expected bounds")
 

gs/backend/positioning/tle.py

@@ -63,20 +63,16 @@ def to_tle(self) -> str:
         )
         first_line += str(calculate_checksum(first_line))
         second_line += str(calculate_checksum(second_line))
-        #print("hi!")
-        #print(f"{first_line}\n{second_line}")
         return f"{first_line}\n{second_line}"
 
     def format_epoch_to_date(self, epoch_year: int, epoch_day: float) -> str:
         """
-            Convert epoch year and day-of-year to a calendar date (YYYY-MM-DD).
+        Convert epoch year and day-of-year to a calendar date (YYYY-MM-DD).
 
-        Arguments:
-            epoch_year (int): Last two digits of the epoch year.
-            epoch_day (float): Day of the year, including fraction.
+        :param epoch_year (int): Last two digits of the epoch year.
+        :param epoch_day (float): Day of the year, including fraction.
 
-        Returns:
-            str: Formatted date string in YYYY-MM-DD format.
+        :return: Returns formatted date string in YYYY-MM-DD format as a string.
         """
         full_year = 2000 + epoch_year if epoch_year < 57 else 1900 + epoch_year
         base_date = datetime(full_year, 1, 1) + timedelta(days=epoch_day - 1)
@@ -90,7 +86,13 @@ def convert_epoch_values_to_jd(self) -> float:
 
 
 def calculate_checksum(line: str) -> int:
-    """Calculate the checksum for a line of TLE data."""
+    """
+    Calculate the checksum for a line of TLE data.
+    
+    :param line(str): The single line of TLE data to calculate the checksum for
+    :return: Returns the checksum integer
+
+    """
     output = 0
     for i in line[:68]:
         if i.isdigit():
@@ -101,7 +103,12 @@ def calculate_checksum(line: str) -> int:
 
 
 def convert_decimal_point_assumed(value: str) -> float:
-    """Convert a string to a float, assuming a decimal point before the last digit."""
+    """
+    Convert a string to a float, assuming a decimal point before the last digit.
+
+    :param value(str): the string to convert
+    :returns: data from string converted into float
+    """
     return float(f"{value[0]}.{value[1:6]}e{value[6:]}")