JuliaGraphs / JuliaGraphs/Graphs.jl
GraphsFlows.jl is unreachable from docs
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 538
- Forks
- 128
- Avg merge
- 10h 25m
- Merged PRs (30d)
- 2
Description
The current documentation doesn't even mention the existence of GraphsFlows.jl. It deserves a "Flows" section in "Algorithms API". This might also be true for other modules that are not shipped with Graphs.jl.
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 in the documentation's Algorithms API section and inspect how modules are organized and linked. Add a Flows section for GraphsFlows.jl, then check whether other modules mentioned in the issue are similarly absent; done means the package is discoverable from the Algorithms API.
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
- 42/100