Align doc strings

FlorentinD · FlorentinD · commit 3cdd4f94255d · 2025-11-27T13:19:30.000+01:00
diff --git a/graphdatascience/procedure_surface/api/pathfinding/dijkstra_endpoints.py b/graphdatascience/procedure_surface/api/pathfinding/dijkstra_endpoints.py
@@ -177,7 +177,7 @@ def write(
         G
            Graph object to use
         write_relationship_type : str
-            The relationship type to use for the new relationships.
+            Name of the relationship type to store the results in.
         source_node
             Node id to use as the starting point.
         target_nodes : int | list[int]
diff --git a/graphdatascience/procedure_surface/api/pathfinding/longest_path_endpoints.py b/graphdatascience/procedure_surface/api/pathfinding/longest_path_endpoints.py
@@ -13,6 +13,7 @@ class LongestPathEndpoints(ABC):
     def stream(
         self,
         G: GraphV2,
+        *,
         relationship_weight_property: str | None = None,
         relationship_types: list[str] = ALL_TYPES,
         node_labels: list[str] = ALL_LABELS,
diff --git a/graphdatascience/procedure_surface/api/pathfinding/max_flow_endpoints.py b/graphdatascience/procedure_surface/api/pathfinding/max_flow_endpoints.py
@@ -38,9 +38,9 @@ def mutate(
         G
            Graph object to use
         mutate_property
-            Name of the node property to store the flow results in.
+            Name of the node property to store the results in.
         mutate_relationship_type
-            Name of the relationship type to store the flow relationships in.
+            Name of the relationship type to store the results in.
         capacity_property
             Name of the relationship property containing capacities.
         concurrency
@@ -198,9 +198,9 @@ def write(
         G
            Graph object to use
         write_property
-            Name of the node property to store the flow results in.
+            Name of the node property to store the results in.
         write_relationship_type
-            Name of the relationship type to store the flow relationships in.
+            Name of the relationship type to store the results in.
         capacity_property
             Name of the relationship property containing capacities.
         concurrency
diff --git a/graphdatascience/procedure_surface/api/pathfinding/prize_steiner_tree_endpoints.py b/graphdatascience/procedure_surface/api/pathfinding/prize_steiner_tree_endpoints.py
@@ -215,7 +215,7 @@ def write(
         G
            Graph object to use
         write_relationship_type : str
-            The relationship type to use for the new relationships.
+            Name of the relationship type to store the results in.
         write_property
             Name of the node property to store the results in.
         prize_property : str
diff --git a/graphdatascience/procedure_surface/api/pathfinding/single_source_bellman_ford_endpoints.py b/graphdatascience/procedure_surface/api/pathfinding/single_source_bellman_ford_endpoints.py
@@ -216,7 +216,7 @@ def write(
         G
            Graph object to use
         write_relationship_type : str
-            The relationship type to use for the new relationships.
+            Name of the relationship type to store the results in.
         source_node
             Node id to use as the starting point.
         write_node_ids : bool, default=False
diff --git a/graphdatascience/procedure_surface/api/pathfinding/single_source_delta_endpoints.py b/graphdatascience/procedure_surface/api/pathfinding/single_source_delta_endpoints.py
@@ -220,7 +220,7 @@ def write(
         source_node
             Node id to use as the starting point.
         write_relationship_type : str
-            The relationship type to use for the new relationships.
+            Name of the relationship type to store the results in.
         delta : float, default=2.0
             The bucket width for grouping nodes by tentative distance.
         write_node_ids : bool, default=False
diff --git a/graphdatascience/procedure_surface/api/pathfinding/single_source_dijkstra_endpoints.py b/graphdatascience/procedure_surface/api/pathfinding/single_source_dijkstra_endpoints.py
@@ -156,7 +156,7 @@ def write(
         source_node
             Node id to use as the starting point.
         write_relationship_type : str
-            The relationship type to use for the new relationships.
+            Name of the relationship type to store the results in.
         write_node_ids : bool, default=False
             Whether to write node IDs of the shortest path onto the relationship.
         write_costs : bool, default=False
diff --git a/graphdatascience/procedure_surface/api/pathfinding/source_target_astar_endpoints.py b/graphdatascience/procedure_surface/api/pathfinding/source_target_astar_endpoints.py
@@ -172,7 +172,7 @@ def write(
         G
            Graph object to use
         write_relationship_type : str
-            The relationship type to use for the new relationships.
+            Name of the relationship type to store the results in.
         source_node
             Node id to use as the starting point.
         target_node : int
diff --git a/graphdatascience/procedure_surface/api/pathfinding/source_target_dijkstra_endpoints.py b/graphdatascience/procedure_surface/api/pathfinding/source_target_dijkstra_endpoints.py
@@ -158,7 +158,7 @@ def write(
         G
            Graph object to use
         write_relationship_type : str
-            The relationship type to use for the new relationships.
+            Name of the relationship type to store the results in.
         source_node
             Node id to use as the starting point.
         target_nodes : int | list[int]
diff --git a/graphdatascience/procedure_surface/api/pathfinding/source_target_yens_endpoints.py b/graphdatascience/procedure_surface/api/pathfinding/source_target_yens_endpoints.py
@@ -171,7 +171,7 @@ def write(
         G
            Graph object to use
         write_relationship_type : str
-            The relationship type to use for the new relationships.
+            Name of the relationship type to store the results in.
         source_node
             Node id to use as the starting point.
         target_node : int
diff --git a/graphdatascience/procedure_surface/api/pathfinding/spanning_tree_endpoints.py b/graphdatascience/procedure_surface/api/pathfinding/spanning_tree_endpoints.py
@@ -222,7 +222,7 @@ def write(
         G
            Graph object to use
         write_relationship_type : str
-            The relationship type to use for the new relationships.
+            Name of the relationship type to store the results in.
         write_property
             Name of the node property to store the results in.
         source_node
diff --git a/graphdatascience/procedure_surface/api/pathfinding/steiner_tree_endpoints.py b/graphdatascience/procedure_surface/api/pathfinding/steiner_tree_endpoints.py
@@ -245,7 +245,7 @@ def write(
         G
            Graph object to use
         write_relationship_type : str
-            The relationship type to use for the new relationships.
+            Name of the relationship type to store the results in.
         write_property
             Name of the node property to store the results in.
         source_node
diff --git a/graphdatascience/procedure_surface/api/similarity/knn_endpoints.py b/graphdatascience/procedure_surface/api/similarity/knn_endpoints.py
@@ -271,7 +271,7 @@ def write(
         G
            Graph object to use
         write_relationship_type : str
-            The relationship type to use for the new relationships.
+            Name of the relationship type to store the results in.
         write_property
             Name of the node property to store the results in.
         node_properties:  str | list[str] | dict[str, str],
diff --git a/graphdatascience/procedure_surface/api/similarity/knn_filtered_endpoints.py b/graphdatascience/procedure_surface/api/similarity/knn_filtered_endpoints.py
@@ -306,7 +306,7 @@ def write(
         G
            Graph object to use
         write_relationship_type : str
-            The relationship type to use for the new relationships.
+            Name of the relationship type to store the results in.
         write_property
             Name of the node property to store the results in.
         node_properties : str | list[str] | dict[str, str]
diff --git a/graphdatascience/procedure_surface/api/similarity/node_similarity_endpoints.py b/graphdatascience/procedure_surface/api/similarity/node_similarity_endpoints.py
@@ -271,7 +271,7 @@ def write(
         G
            Graph object to use
         write_relationship_type : str
-            The relationship type to use for the new relationships.
+            Name of the relationship type to store the results in.
         write_property
             Name of the node property to store the results in.
         top_k
diff --git a/graphdatascience/procedure_surface/api/similarity/node_similarity_filtered_endpoints.py b/graphdatascience/procedure_surface/api/similarity/node_similarity_filtered_endpoints.py
@@ -285,7 +285,7 @@ def write(
         G
            Graph object to use
         write_relationship_type : str
-            The relationship type to use for the new relationships.
+            Name of the relationship type to store the results in.
         write_property
             Name of the node property to store the results in.
         source_node_filter : str | list[int]
diff --git a/graphdatascience/procedure_surface/arrow/pathfinding/longest_path_arrow_endpoints.py b/graphdatascience/procedure_surface/arrow/pathfinding/longest_path_arrow_endpoints.py
@@ -23,6 +23,7 @@ def __init__(
     def stream(
         self,
         G: GraphV2,
+        *,
         relationship_weight_property: str | None = None,
         relationship_types: list[str] = ALL_TYPES,
         node_labels: list[str] = ALL_LABELS,
diff --git a/graphdatascience/procedure_surface/cypher/pathfinding/longest_path_cypher_endpoints.py b/graphdatascience/procedure_surface/cypher/pathfinding/longest_path_cypher_endpoints.py
@@ -17,6 +17,7 @@ def __init__(self, query_runner: QueryRunner):
     def stream(
         self,
         G: GraphV2,
+        *,
         relationship_weight_property: str | None = None,
         relationship_types: list[str] = ALL_TYPES,
         node_labels: list[str] = ALL_LABELS,
diff --git a/graphdatascience/tests/integrationV2/procedure_surface/session/resources/parameters.json b/graphdatascience/tests/integrationV2/procedure_surface/session/resources/parameters.json
@@ -54,5 +54,6 @@
   "use_wasserman_faust": "Use the improved Wasserman-Faust formula for closeness computation.",
   "username": "As an administrator, impersonate a different user for accessing their graphs.",
   "write_concurrency": "Number of concurrent threads to use for writing.",
-  "write_property": "Name of the node property to store the results in."
+  "write_property": "Name of the node property to store the results in.",
+  "write_relationship_type": "Name of the relationship type to store the results in."
 }

Original file line number	Diff line number	Diff line change
`@@ -177,7 +177,7 @@ def write(`
`177`	`177`	`G`
`178`	`178`	`Graph object to use`
`179`	`179`	`write_relationship_type : str`
`180`		`- The relationship type to use for the new relationships.`
	`180`	`+ Name of the relationship type to store the results in.`
`181`	`181`	`source_node`
`182`	`182`	`Node id to use as the starting point.`
`183`	`183`	`target_nodes : int \| list[int]`
Original file line number	Diff line number	Diff line change
`@@ -215,7 +215,7 @@ def write(`
`215`	`215`	`G`
`216`	`216`	`Graph object to use`
`217`	`217`	`write_relationship_type : str`
`218`		`- The relationship type to use for the new relationships.`
	`218`	`+ Name of the relationship type to store the results in.`
`219`	`219`	`write_property`
`220`	`220`	`Name of the node property to store the results in.`
`221`	`221`	`prize_property : str`
Original file line number	Diff line number	Diff line change
`@@ -216,7 +216,7 @@ def write(`
`216`	`216`	`G`
`217`	`217`	`Graph object to use`
`218`	`218`	`write_relationship_type : str`
`219`		`- The relationship type to use for the new relationships.`
	`219`	`+ Name of the relationship type to store the results in.`
`220`	`220`	`source_node`
`221`	`221`	`Node id to use as the starting point.`
`222`	`222`	`write_node_ids : bool, default=False`
Original file line number	Diff line number	Diff line change
`@@ -172,7 +172,7 @@ def write(`
`172`	`172`	`G`
`173`	`173`	`Graph object to use`
`174`	`174`	`write_relationship_type : str`
`175`		`- The relationship type to use for the new relationships.`
	`175`	`+ Name of the relationship type to store the results in.`
`176`	`176`	`source_node`
`177`	`177`	`Node id to use as the starting point.`
`178`	`178`	`target_node : int`
Original file line number	Diff line number	Diff line change
`@@ -158,7 +158,7 @@ def write(`
`158`	`158`	`G`
`159`	`159`	`Graph object to use`
`160`	`160`	`write_relationship_type : str`
`161`		`- The relationship type to use for the new relationships.`
	`161`	`+ Name of the relationship type to store the results in.`
`162`	`162`	`source_node`
`163`	`163`	`Node id to use as the starting point.`
`164`	`164`	`target_nodes : int \| list[int]`
Original file line number	Diff line number	Diff line change
`@@ -171,7 +171,7 @@ def write(`
`171`	`171`	`G`
`172`	`172`	`Graph object to use`
`173`	`173`	`write_relationship_type : str`
`174`		`- The relationship type to use for the new relationships.`
	`174`	`+ Name of the relationship type to store the results in.`
`175`	`175`	`source_node`
`176`	`176`	`Node id to use as the starting point.`
`177`	`177`	`target_node : int`