JuliaDataCubes / JuliaDataCubes/EarthDataLab.jl
Use DocStringExtensions
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 34
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/JuliaDocs/DocStringExtensions.jl gives nice functionality to get some informations about the functions or structs programmtically, so that the docstrings are tied to the actual code.
I would like to revamp this after we merged the splitpackages branch.
Contributor guide
No contributing guide indexed for this repository
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
Review DocStringExtensions.jl and the splitpackages branch first; the issue provides no repository files or tests to start from. Done means the project's docstrings use DocStringExtensions so they remain tied to the actual functions or structs programmatically after the package split is merged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100