From 7549f6a934c7fd85a999d5bf3283c8cdaea273e3 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Mon, 30 Sep 2024 17:29:16 -0400 Subject: [PATCH] fix: docstring --- nx_arangodb/classes/digraph.py | 8 ++++---- nx_arangodb/classes/graph.py | 8 ++++---- nx_arangodb/classes/multidigraph.py | 8 ++++---- nx_arangodb/classes/multigraph.py | 8 ++++---- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/nx_arangodb/classes/digraph.py b/nx_arangodb/classes/digraph.py index 09df294..8467bc9 100644 --- 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 index 86414e9..27b0c39 100644 --- 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 index 451b501..7ca7652 100644 --- 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 index 0ce983e..1a4b1eb 100644 --- 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.