JuliaDocs / JuliaDocs/DocStringExtensions.jl
New SUBTYPES exported key
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 126
- Forks
- 35
- PR merge metrics
- No merged PRs in 30d
Description
I am often finding myself in the situation where I dewsign an interface, and the algorithm-deciding arugments of the interface are all subtypes of a main abstract type. Like
abstarct type A end
struct Method1 <: A end
struct Method2 <: A end
In this case, I always cross-reference the subtypes of A in the docstring of A, as the same docstring describes the interface. It would be great to have a SUBTYPES key in the extensions here, so that it expands all subtypes of A into a Documetner [@ref] wrapp.
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
No file or test paths are mentioned. Start by locating the existing extension-key implementation and examining how its documented @ref expansion works; done means a SUBTYPES key expands the subtypes of an abstract type into Documenter @ref links as described by the example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100