SciML / SciML/MultiScaleArrays.jl
Improve docstrings
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 77
- Forks
- 17
- Avg merge
- 8h 9m
- Merged PRs (30d)
- 12
Description
Such that makedocs warnonly = [:missing_docs] 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 at the documentation build entry point around makedocs and identify the missing-documentation warnings produced with warnonly = [:missing_docs]. Done means the relevant docstrings are improved enough that warnonly = [:missing_docs] can be removed without missing-documentation warnings.
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