fix: docstring

arangodb · Sep 30, 2024 · 7549f6a · 7549f6a
1 parent 35100f9
commit 7549f6a
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 16 deletions.
diff --git a/nx_arangodb/classes/digraph.py b/nx_arangodb/classes/digraph.py
@@ -126,10 +126,10 @@ class DiGraph(Graph, nx.DiGraph):
         as expected.
 
     overwrite_graph : bool (optional, default: False)
-        Whether to truncate the graph collections when the graph is loaded from
-        the database. If set to True, the graph collections will be truncated
-        before loading the graph data. NOTE: This parameter only applies if the
-        graph already exists in the database.
+        Whether to overwrite the graph in the database if it already exists. If
+        set to True, the graph collections will be dropped and recreated. Note that
+        this operation is irreversible and will result in the loss of all data in
+        the graph. NOTE: If set to True, Collection Indexes will also be lost.
 
     args: positional arguments for nx.Graph
         Additional arguments passed to nx.Graph.

diff --git a/nx_arangodb/classes/graph.py b/nx_arangodb/classes/graph.py
@@ -160,10 +160,10 @@ class Graph(nx.Graph):
         as expected.
 
     overwrite_graph : bool (optional, default: False)
-        Whether to truncate the graph collections when the graph is loaded from
-        the database. If set to True, the graph collections will be truncated
-        before loading the graph data. NOTE: This parameter only applies if the
-        graph already exists in the database.
+        Whether to overwrite the graph in the database if it already exists. If
+        set to True, the graph collections will be dropped and recreated. Note that
+        this operation is irreversible and will result in the loss of all data in
+        the graph. NOTE: If set to True, Collection Indexes will also be lost.
 
     args: positional arguments for nx.Graph
         Additional arguments passed to nx.Graph.

diff --git a/nx_arangodb/classes/multidigraph.py b/nx_arangodb/classes/multidigraph.py
@@ -136,10 +136,10 @@ class MultiDiGraph(MultiGraph, DiGraph, nx.MultiDiGraph):
         as expected.
 
     overwrite_graph : bool (optional, default: False)
-        Whether to truncate the graph collections when the graph is loaded from
-        the database. If set to True, the graph collections will be truncated
-        before loading the graph data. NOTE: This parameter only applies if the
-        graph already exists in the database.
+        Whether to overwrite the graph in the database if it already exists. If
+        set to True, the graph collections will be dropped and recreated. Note that
+        this operation is irreversible and will result in the loss of all data in
+        the graph. NOTE: If set to True, Collection Indexes will also be lost.
 
     args: positional arguments for nx.Graph
         Additional arguments passed to nx.Graph.

diff --git a/nx_arangodb/classes/multigraph.py b/nx_arangodb/classes/multigraph.py
@@ -137,10 +137,10 @@ class MultiGraph(Graph, nx.MultiGraph):
         as expected.
 
     overwrite_graph : bool (optional, default: False)
-        Whether to truncate the graph collections when the graph is loaded from
-        the database. If set to True, the graph collections will be truncated
-        before loading the graph data. NOTE: This parameter only applies if the
-        graph already exists in the database.
+        Whether to overwrite the graph in the database if it already exists. If
+        set to True, the graph collections will be dropped and recreated. Note that
+        this operation is irreversible and will result in the loss of all data in
+        the graph. NOTE: If set to True, Collection Indexes will also be lost.
 
     args: positional arguments for nx.Graph
         Additional arguments passed to nx.Graph.