SciML / SciML/DataDrivenDiffEq.jl
Improve docstrings
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 430
- Forks
- 58
- Avg merge
- 6h 29m
- Merged PRs (30d)
- 28
Description
Such that makedocs warnonly = [:missing_docs, :cross_references] can be removed.
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 documentation build and inspect the warnings produced by makedocs under warnonly = [:missing_docs, :cross_references]. Identify the undocumented or incorrectly referenced Julia APIs, improve their docstrings, and consider the work done when those warning categories can be removed from warnonly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100