JuliaDocs / JuliaDocs/DocStringExtensions.jl
SUBTYPES abbreviation
Open
Nobody has claimed this yet.
Status: Available
Type: Feature
- Dominant language
- Julia
- Stars
- 126
- Forks
- 35
- PR merge metrics
- No merged PRs in 30d
Description
It may be useful to add a SUBTYPES abbreviation that expands to something like
subtypes: [`SubType1`](@ref), [`SubType2`](@ref), ...
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 locating the existing abbreviation implementations in DocStringExtensions.jl and compare how they expand references. Add a SUBTYPES abbreviation that produces linked subtype entries like the example, then run the project's existing tests to verify the generated documentation output.
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