JuliaGraphs / JuliaGraphs/Graphs.jl
Better doc for `AbstractPathState`
A pull request for this has already been merged.
- #302 by @gdalle — merged
- Dominant language
- Julia
- Stars
- 538
- Forks
- 128
- Avg merge
- 10h 25m
- Merged PRs (30d)
- 2
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the AbstractPathState definition in src/core.jl at lines 1–5 and the dijkstra_shortest_path(g) result mentioned in the issue. Add documentation describing the type and a worked example that extracts a shortest path between two vertices from D; the issue is complete when those uses are clear to readers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100