JuliaDocs / JuliaDocs/DocStringExtensions.jl
suggestion: INSTANCES template
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 126
- Forks
- 35
- PR merge metrics
- No merged PRs in 30d
Description
For inserting instances(enum) into a docstring documenting an @enum ... construct.
I am happy to make a PR is the maintainers think that this would make sense.
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
Start by reviewing the existing docstring templates and the handling of @enum constructs in this repository. Determine how an instances(enum) template should be exposed and documented, then verify that it expands correctly for an enum and matches the project's existing template conventions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100