Skip to content

Commit b556e98

Browse files
authored
doc: word wrapping in improved get_shortest_path() docs for the console
1 parent 1920c4e commit b556e98

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/_igraph/graphobject.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15122,7 +15122,8 @@ 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"
15125+
"This function only returns a single shortest path. Consider using L{get_shortest_paths()}\n"
15126+
"to find all shortest paths between a source and one or more target vertices.\n\n"
1512615127
"@param v: the source vertex of the path\n"
1512715128
"@param to: the target vertex of the path\n"
1512815129
"@param weights: edge weights in a list or the name of an edge attribute\n"

0 commit comments

Comments
 (0)