CliMA / CliMA/ClimaAnalysis.jl
Improve documentation
- Dominant language
- Julia
- Stars
- 12
- Forks
- 5
- Avg merge
- 6d 17h
- Merged PRs (30d)
- 3
Description
I think we can improve the documentation by including a bit more type information, and by including more copy-paste-friendly examples. I've found some of the documentation to gloss over the types of variables, or assume that some variables exist, and it makes the examples hard to understand / reproduce.
Contributor guide
No contributing guide indexed for this repository
Research direction
The issue names no documentation files, tests, or examples. Start by locating documentation pages and examples that omit variable types or rely on unstated variables, then identify which examples cannot be copied and reproduced as written. Done means the selected documentation explains relevant variable types and uses self-contained, copy-paste-friendly examples.
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