Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renamed graph.bfs_edges to edge_bfs #1604

Merged
merged 3 commits into from
Sep 29, 2024

Conversation

BenWeber42
Copy link
Contributor

networkx has similar methods bfs_edges and edge_bfs for their graph classes. There is a slight and documented difference between the two: https://networkx.org/documentation/stable/reference/algorithms/generated/networkx.algorithms.traversal.edgebfs.edge_bfs.html#networkx.algorithms.traversal.edgebfs.edge_bfs

Unfortunately, our graph.bfs_edges behaves differently to networkx's bfs_edges. In fact, it behaves exactly like networkx's edge_bfs. To avoid future confusion (just happened to me), I propose renaming our bfs_edges to edge_bfs to be consistent with networkx.

@BenWeber42 BenWeber42 force-pushed the rename-graph-bfs-edges branch from 0aca744 to 1431f36 Compare June 20, 2024 12:05
@BenWeber42 BenWeber42 force-pushed the rename-graph-bfs-edges branch from 1431f36 to abe5a86 Compare September 17, 2024 19:53
Copy link
Collaborator

@tbennun tbennun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good

@tbennun tbennun added this pull request to the merge queue Sep 29, 2024
Merged via the queue into spcl:master with commit 74a31cb Sep 29, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants