search

JuliaGraphs / Graphs.jl

An optimized graphs package for the Julia programming language
http://juliagraphs.org/Graphs.jl/
Other
457 stars 90 forks source link

Better doc for `AbstractPathState` #211

Open SimonCoste opened 1 year ago

SimonCoste commented 1 year ago

https://github.com/JuliaGraphs/Graphs.jl/blob/1a7594a448b0c8fe9251ac7e88fd1b5ab0989e87/src/core.jl#L1-L5

Could we have a documentation for AbstractPathState ? Currently, the total information in the doc about this type is almost zero, or at least I could not easily find it.

For instance it could be nice to have a worked example explaining how to use, e.g. the result of D=dijkstra_shortest_path(g) to effectively extract the shortest path between two vertices directly from D.

gdalle commented 1 year ago

Related: #152

gdalle commented 1 year ago

Not linking to the PR because I'm keeping the idea of an explicit example for retrieving the shortest path