docs: better describe output of all_shortest_paths()
#1626
Conversation
Current Aviator status
This pull request is currently open (not queued). How to mergeTo merge this PR, comment
See the real-time status of this PR on the
Aviator webapp.
Use the Aviator Chrome Extension
to see the status of your PR within GitHub.
|
| #' For `all_shortest_paths()` a list is returned: | ||
| #' \item{vpaths}{This is a list. Each list element | ||
| #' contains a shortest path from `from` to a vertex in `to`. The | ||
| #' shortest paths to the same vertex are collected into consecutive elements | ||
| #' of the list. | ||
| #' of the list.} |
There was a problem hiding this comment.
Let's write
... contains the vertices of a shortest path ...
| #' but the vectors of the list contain the edge ids along the shortest paths, | ||
| #' instead of the vertex ids.} |
There was a problem hiding this comment.
Nitpick: Let's decide whether we write "ID" or "id" and stick to it.
| #' but the vectors of the list contain the edge ids along the shortest paths, | ||
| #' instead of the vertex ids.} | ||
| #' \item{nrgeo}{Number of geodesics.} | ||
| #' \item{res}{} |
There was a problem hiding this comment.
For nrgeo:
A vector in which each element is the number of shortest paths (geodesics) from
fromto the corresponding vertex into.
|
|
|
@maelle: Should this be part of the upcoming 2.1.3? |
Fix #1029
@szhorvat I'll need your help.