diff options
| author | Nanda H Krishna <nanda.harishankar@gmail.com> | 2019-06-29 07:55:08 +0530 |
|---|---|---|
| committer | Dan Schult <dschult@colgate.edu> | 2019-06-29 12:25:08 +1000 |
| commit | e510ac1fc759f54acac2c63a52801e84f74460f6 (patch) | |
| tree | ae7a78aaa3e2bd00b8b16cb4aaef79fcf61b592c | |
| parent | 58a762b20fc3b14d0d3a0d919f816bc4c4ed92f9 (diff) | |
| download | networkx-e510ac1fc759f54acac2c63a52801e84f74460f6.tar.gz | |
Fixed incorrect docs (#3495)
Fixes #3483 which was already partially fixed by #3484
| -rw-r--r-- | networkx/algorithms/traversal/breadth_first_search.py | 14 | ||||
| -rw-r--r-- | networkx/algorithms/traversal/depth_first_search.py | 9 |
2 files changed, 9 insertions, 14 deletions
diff --git a/networkx/algorithms/traversal/breadth_first_search.py b/networkx/algorithms/traversal/breadth_first_search.py index 87f8c750..318f998b 100644 --- a/networkx/algorithms/traversal/breadth_first_search.py +++ b/networkx/algorithms/traversal/breadth_first_search.py @@ -95,8 +95,9 @@ def bfs_edges(G, source, reverse=False, depth_limit=None): G : NetworkX graph source : node - Specify starting node for breadth-first search and return edges in - the component reachable from source. + Specify starting node for breadth-first search; this function + iterates over only those edges in the component reachable from + this node. reverse : bool, optional If True traverse a directed graph in the reverse direction @@ -155,8 +156,7 @@ def bfs_tree(G, source, reverse=False, depth_limit=None): G : NetworkX graph source : node - Specify starting node for breadth-first search and return edges in - the component reachable from source. + Specify starting node for breadth-first search reverse : bool, optional If True traverse a directed graph in the reverse direction @@ -205,8 +205,7 @@ def bfs_predecessors(G, source, depth_limit=None): G : NetworkX graph source : node - Specify starting node for breadth-first search and return edges in - the component reachable from source. + Specify starting node for breadth-first search depth_limit : int, optional(default=len(G)) Specify the maximum search depth @@ -254,8 +253,7 @@ def bfs_successors(G, source, depth_limit=None): G : NetworkX graph source : node - Specify starting node for breadth-first search and return edges in - the component reachable from source. + Specify starting node for breadth-first search depth_limit : int, optional(default=len(G)) Specify the maximum search depth diff --git a/networkx/algorithms/traversal/depth_first_search.py b/networkx/algorithms/traversal/depth_first_search.py index b358d6db..e637e8f5 100644 --- a/networkx/algorithms/traversal/depth_first_search.py +++ b/networkx/algorithms/traversal/depth_first_search.py @@ -142,8 +142,7 @@ def dfs_predecessors(G, source=None, depth_limit=None): G : NetworkX graph source : node, optional - Specify starting node for depth-first search and return edges in - the component reachable from source. + Specify starting node for depth-first search. depth_limit : int, optional (default=len(G)) Specify the maximum search depth. @@ -185,8 +184,7 @@ def dfs_successors(G, source=None, depth_limit=None): G : NetworkX graph source : node, optional - Specify starting node for depth-first search and return edges in - the component reachable from source. + Specify starting node for depth-first search. depth_limit : int, optional (default=len(G)) Specify the maximum search depth. @@ -231,8 +229,7 @@ def dfs_postorder_nodes(G, source=None, depth_limit=None): G : NetworkX graph source : node, optional - Specify starting node for depth-first search and return edges in - the component reachable from source. + Specify starting node for depth-first search. depth_limit : int, optional (default=len(G)) Specify the maximum search depth. |