JuliaGraphs / JuliaGraphs/Graphs.jl
Add example of API implementation to the docs
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Julia
- Stars
- 538
- Forks
- 128
- Avg merge
- 10h 25m
- Merged PRs (30d)
- 2
Description
Maybe even an interface check with RequiredInterfaces.jl? I think we can make it nonbreaking
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
The issue does not identify a documentation file, test, or API entry point. Start by locating the existing API documentation and reviewing the proposed RequiredInterfaces.jl check. Done should include a concrete API implementation example and a confirmed nonbreaking interface check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100