Skip to content

Commit db30879

Browse files
authored
docs: document negative/infinite order neighborhood (#815)
* docs: document negative/infinite order neighborhood after the corresponding change in the C core * chore: update C core
1 parent 5424154 commit db30879

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

src/_igraph/graphobject.c

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15854,7 +15854,8 @@ struct PyMethodDef igraphmodule_Graph_methods[] = {
1585415854
"@param vertices: a single vertex ID or a list of vertex IDs, or\n"
1585515855
" C{None} meaning all the vertices in the graph.\n"
1585615856
"@param order: the order of the neighborhood, i.e. the maximum number of\n"
15857-
" steps to take from the seed vertex.\n"
15857+
" steps to take from the seed vertex. Negative values are interpreted as\n"
15858+
" an infinite order, i.e. no limit on the number of steps.\n"
1585815859
"@param mode: specifies how to take into account the direction of\n"
1585915860
" the edges if a directed graph is analyzed. C{\"out\"} means that\n"
1586015861
" only the outgoing edges are followed, so all vertices reachable\n"
@@ -15882,7 +15883,8 @@ struct PyMethodDef igraphmodule_Graph_methods[] = {
1588215883
"@param vertices: a single vertex ID or a list of vertex IDs, or\n"
1588315884
" C{None} meaning all the vertices in the graph.\n"
1588415885
"@param order: the order of the neighborhood, i.e. the maximum number of\n"
15885-
" steps to take from the seed vertex.\n"
15886+
" steps to take from the seed vertex. Negative values are interpreted as\n"
15887+
" an infinite order, i.e. no limit on the number of steps.\n"
1588615888
"@param mode: specifies how to take into account the direction of\n"
1588715889
" the edges if a directed graph is analyzed. C{\"out\"} means that\n"
1588815890
" only the outgoing edges are followed, so all vertices reachable\n"

vendor/source/igraph

Submodule igraph updated 257 files

0 commit comments

Comments
 (0)