Better doc for `AbstractPathState`

Open SimonCoste opened this issue 3 years ago • 2 comments

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.

Jan 06 '23 18:01 SimonCoste

Related: #152

Jun 28 '23 10:06 gdalle

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

Sep 14 '23 13:09 gdalle