Skip to content

Added clarification to the get_shortest_path() documentation #749#764

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.

Sign up for GitHub

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

Jump to bottom
Merged
ntamas merged 2 commits into from
Mar 14, 2024
Merged

Added clarification to the get_shortest_path() documentation #749 #764

ntamas merged 2 commits into from
Mar 14, 2024

Conversation

@JDPowell648
Copy link

@JDPowell648JDPowell648 commented Mar 13, 2024

Closes#749

@ntamas
Copy link
Member

ntamas commented Mar 14, 2024

Thanks! Will merge when the CI tests pass.

@ntamasntamas merged commit d23e0b1 into igraph:mainMar 14, 2024
@szhorvat
Copy link
Member

szhorvat commented Mar 14, 2024

The phrasing is a bit confusing though.

  • get_shortest_path() finds a shortest path between a source and a target vertex
  • get_shortest_paths() finds a shortest path from a single source to multiple targets (but not all shortest paths!)
  • get_all_shortest_paths() finds all shortest paths from a single source to multiple targets

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ntamasntamasntamas approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Clarify documentation of get_shortest_path

3 participants

@JDPowell648@ntamas@szhorvat