From 3f4f9c3379a5d70fc58852154aab7b1051ff96d6 Mon Sep 17 00:00:00 2001 From: ernstklrb <33454758+ernstklrb@users.noreply.github.com> Date: Wed, 26 Feb 2020 20:07:35 +0100 Subject: [PATCH] fix typo slightly confusing the meaning (#3840) --- networkx/algorithms/traversal/breadth_first_search.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/networkx/algorithms/traversal/breadth_first_search.py b/networkx/algorithms/traversal/breadth_first_search.py index 9966307509d..95eaef0a985 100644 --- a/networkx/algorithms/traversal/breadth_first_search.py +++ b/networkx/algorithms/traversal/breadth_first_search.py @@ -119,12 +119,12 @@ def bfs_edges(G, source, reverse=False, depth_limit=None): Notes ----- - The naming of this function is very similar to bfs_edges. The difference + The naming of this function is very similar to edge_bfs. The difference is that 'edge_bfs' yields edges even if they extend back to an already explored node while 'bfs_edges' yields the edges of the tree that results from a breadth-first-search (BFS) so no edges are reported if they extend to already explored nodes. That means 'edge_bfs' reports all edges while - 'bfs_edges' only report those traversed by a node-based BFS. Yet another + 'bfs_edges' only reports those traversed by a node-based BFS. Yet another description is that 'bfs_edges' reports the edges traversed during BFS while 'edge_bfs' reports all edges in the order they are explored.