Skip to content

Commit

Permalink
fix typo slightly confusing the meaning (networkx#3840)
Browse files Browse the repository at this point in the history
  • Loading branch information
ernstklrb authored Feb 26, 2020
1 parent acae7c5 commit 3f4f9c3
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions networkx/algorithms/traversal/breadth_first_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 3f4f9c3

Please sign in to comment.