Skip to content

Commit 1920c4e

Browse files
author
jpowell11
committed
Added clarification to the get_shortest_path() documentation
1 parent ecfced6 commit 1920c4e

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/_igraph/graphobject.c

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15122,6 +15122,7 @@ struct PyMethodDef igraphmodule_Graph_methods[] = {
1512215122
METH_VARARGS | METH_KEYWORDS,
1512315123
"get_shortest_path(v, to, weights=None, mode=\"out\", output=\"vpath\", algorithm=\"auto\")\n--\n\n"
1512415124
"Calculates the shortest path from a source vertex to a target vertex in a graph.\n\n"
15125+
"This function only returns a single shortest path, to find all shortest paths consider using L{get_shortest_paths()}.\n\n"
1512515126
"@param v: the source vertex of the path\n"
1512615127
"@param to: the target vertex of the path\n"
1512715128
"@param weights: edge weights in a list or the name of an edge attribute\n"
@@ -15139,7 +15140,8 @@ struct PyMethodDef igraphmodule_Graph_methods[] = {
1513915140
" algorithm automatically based on whether the graph has negative weights\n"
1514015141
" or not. C{\"dijkstra\"} uses Dijkstra's algorithm. C{\"bellman_ford\"}\n"
1514115142
" uses the Bellman-Ford algorithm. Ignored for unweighted graphs.\n"
15142-
"@return: see the documentation of the C{output} parameter.\n"},
15143+
"@return: see the documentation of the C{output} parameter.\n"
15144+
"@see: L{get_shortest_paths()}\n"},
1514315145

1514415146
/* interface to igraph_get_shortest_paths */
1514515147
{"get_shortest_paths", (PyCFunction) igraphmodule_Graph_get_shortest_paths,

0 commit comments

Comments
 (0)