Finished fixing the docstrings.

Author: arienandalibi

python/python/raphtory/__init__.pyi

@@ -1538,7 +1538,7 @@ def test_zero_step():
     graph = Graph()
     create_graph_epoch(graph)
     queries_and_exceptions = []
-    zero_exception = "Failed to parse time string: 0 size step is not supported"
+    zero_exception = "Failed to parse time string: 0 size step is not supported."
     # graph fail test
     query = """
     {
@@ -2200,8 +2200,8 @@ def test_wrong_window():
     create_graph_epoch(graph)
     queries_and_exceptions = []
     mismatch_exception = "Your window and step must be of the same type: duration (string) or epoch (int)"
-    parse_exception = "Failed to parse time string: one of the tokens in the interval string supposed to be a number couldn't be parsed"
-    parse_exception2 = "Failed to parse time string: 'monthdas' is not a valid unit"
+    parse_exception = "Failed to parse time string: One of the tokens in the interval string supposed to be a number couldn't be parsed."
+    parse_exception2 = "Failed to parse time string: 'monthdas' is not a valid unit."
     too_many_exception = "Invalid value for argument \\"
     # graph fail test
     query = """

python/python/raphtory/node_state/__init__.pyi

@@ -45,10 +45,10 @@ pub trait AsTime: fmt::Debug + Copy + Ord + Eq + Send + Sync + 'static {
     /// Converts the timestamp into a UTC DateTime.
     ///
     /// # Returns:
-    /// * `DateTime`
+    ///    `DateTime`:
     ///
     /// # Raises:
-    /// * `TimeError`: Returns TimestampError on out-of-range timestamps.
+    ///  `TimeError`: Returns TimestampError on out-of-range timestamps.
     fn dt(&self) -> Result<DateTime<Utc>, TimeError> {
         let t = self.t();
         DateTime::from_timestamp_millis(t).ok_or(TimeError::OutOfRange(t))

python/tests/test_base_install/test_graphql/test_rolling_expanding.py

@@ -10,7 +10,9 @@ use std::{convert::Infallible, num::ParseIntError};
 pub enum ParseTimeError {
     #[error("The interval string doesn't contain a complete number of number-unit pairs.")]
     InvalidPairs,
-    #[error("One of the tokens in the interval string supposed to be a number couldn't be parsed.")]
+    #[error(
+        "One of the tokens in the interval string supposed to be a number couldn't be parsed."
+    )]
     ParseInt {
         #[from]
         source: ParseIntError,
@@ -142,7 +144,8 @@ impl TryIntoTimeNeedsSecondaryIndex for NaiveDateTime {}
 
 impl TryIntoTimeNeedsSecondaryIndex for &str {}
 
-/// Used to handle automatic injection of secondary index if not explicitly provided
+/// Used to handle automatic injection of secondary index if not explicitly provided.
+/// In many cases, we will want different behaviour if a secondary index was provided or not.
 pub enum InputTime {
     Simple(i64),
     Indexed(i64, usize),
@@ -164,7 +167,7 @@ impl InputTime {
     }
 }
 
-// Single time input only refers to the i64 component of a TimeIndexEntry (without a secondary index).
+/// Single time input only refers to the i64 component of a TimeIndexEntry (no secondary index).
 pub trait AsSingleTimeInput {
     fn try_into_input_time(self) -> Result<InputTime, ParseTimeError>;
 }

raphtory-api/src/core/storage/timeindex.rs

@@ -31,8 +31,8 @@ impl<'source> FromPyObject<'source> for TimeIndexEntry {
     }
 }
 
-/// Components that can make a TimeIndexEntry. Extract them from Python as individual components so we can support tuples for TimeIndexEntry
-/// They can be used as the secondary index as well.
+/// Components that can make a TimeIndexEntry. They can be used as the secondary index as well.
+/// Extract them from Python as individual components so we can support tuples for TimeIndexEntry.
 #[derive(Debug, Clone, Copy)]
 pub struct TimeIndexComponent {
     component: i64,
@@ -154,16 +154,19 @@ impl PyTimeIndexEntry {
 #[pymethods]
 impl PyTimeIndexEntry {
     /// Return the UTC datetime representation of this time entry.
+    ///
     /// Returns:
     ///     datetime: The UTC datetime corresponding to this entry's timestamp.
+    ///
     /// Raises:
-    ///     TimeError: Returns TimestampError on out-of-range timestamps.
+    ///     TimeError: Returns TimeError on timestamp conversion errors (e.g. out-of-range timestamp).
     #[getter]
     pub fn dt(&self) -> Result<DateTime<Utc>, TimeError> {
         self.time.dt()
     }
 
     /// Return the secondary index associated with this time entry.
+    ///
     /// Returns:
     ///     int: The secondary index.
     #[getter]
@@ -172,6 +175,7 @@ impl PyTimeIndexEntry {
     }
 
     /// Return the Unix timestamp in milliseconds.
+    ///
     /// Returns:
     ///     int: Milliseconds since the Unix epoch.
     #[getter]
@@ -180,8 +184,9 @@ impl PyTimeIndexEntry {
     }
 
     /// Return this entry as a tuple of (timestamp_ms, secondary_index).
+    ///
     /// Returns:
-    /// tuple[int, int]: (timestamp, secondary_index).
+    ///     tuple[int,int]: (timestamp, secondary_index).
     #[getter]
     pub fn as_tuple(&self) -> (i64, usize) {
         self.time.as_tuple()
@@ -228,8 +233,10 @@ impl PyTimeIndexEntry {
     }
 
     /// Create a new TimeIndexEntry.
+    ///
     /// Arguments:
     ///    time (int | float | datetime | str | tuple): The time entry to be created. Pass a tuple/list of two of these components to specify the secondary index as well.
+
     /// Returns:
     ///     TimeIndexEntry: A new time index entry.
     #[staticmethod]