Skip to content

Commit

Permalink
overwrite_graph docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
aMahanna committed Sep 24, 2024
1 parent bbaeee4 commit 8009023
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 0 deletions.
6 changes: 6 additions & 0 deletions nx_arangodb/classes/digraph.py
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,12 @@ class DiGraph(Graph, nx.DiGraph):
whenever possible. NOTE: This feature is experimental and may not work
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.
args: positional arguments for nx.Graph
Additional arguments passed to nx.Graph.
Expand Down
6 changes: 6 additions & 0 deletions nx_arangodb/classes/graph.py
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,12 @@ class Graph(nx.Graph):
whenever possible. NOTE: This feature is experimental and may not work
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.
args: positional arguments for nx.Graph
Additional arguments passed to nx.Graph.
Expand Down
6 changes: 6 additions & 0 deletions nx_arangodb/classes/multidigraph.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,12 @@ class MultiDiGraph(MultiGraph, DiGraph, nx.MultiDiGraph):
whenever possible. NOTE: This feature is experimental and may not work
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.
args: positional arguments for nx.Graph
Additional arguments passed to nx.Graph.
Expand Down
6 changes: 6 additions & 0 deletions nx_arangodb/classes/multigraph.py
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,12 @@ class MultiGraph(Graph, nx.MultiGraph):
whenever possible. NOTE: This feature is experimental and may not work
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.
args: positional arguments for nx.Graph
Additional arguments passed to nx.Graph.
Expand Down

0 comments on commit 8009023

Please sign in to comment.