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

Merged
ntamas merged 2 commits into from
Mar 14, 2024
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1920c4e
Added clarification to the get_shortest_path() documentation
Mar 13, 2024
b556e98
doc: word wrapping in improved get_shortest_path() docs for the console
ntamas Mar 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/_igraph/graphobject.c
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15122,6 +15122,8 @@ struct PyMethodDef igraphmodule_Graph_methods[] ={
METH_VARARGS | METH_KEYWORDS,
"get_shortest_path(v, to, weights=None, mode=\"out\", output=\"vpath\", algorithm=\"auto\")\n--\n\n"
"Calculates the shortest path from a source vertex to a target vertex in a graph.\n\n"
"This function only returns a single shortest path. Consider using L{get_shortest_paths()}\n"
"to find all shortest paths between a source and one or more target vertices.\n\n"
"@param v: the source vertex of the path\n"
"@param to: the target vertex of the path\n"
"@param weights: edge weights in a list or the name of an edge attribute\n"
Expand All@@ -15139,7 +15141,8 @@ struct PyMethodDef igraphmodule_Graph_methods[] ={
" algorithm automatically based on whether the graph has negative weights\n"
" or not. C{\"dijkstra\"} uses Dijkstra's algorithm. C{\"bellman_ford\"}\n"
" uses the Bellman-Ford algorithm. Ignored for unweighted graphs.\n"
"@return: see the documentation of the C{output} parameter.\n"},
"@return: see the documentation of the C{output} parameter.\n"
"@see: L{get_shortest_paths()}\n"},

/* interface to igraph_get_shortest_paths */
{"get_shortest_paths", (PyCFunction) igraphmodule_Graph_get_shortest_paths,
Expand Down