JuliaDocs / JuliaDocs/DocStringExtensions.jl
different abbreviations for concrete and abstract types
Open
Nobody has claimed this yet.
up for grabs
- Dominant language
- Julia
- Stars
- 126
- Forks
- 35
- PR merge metrics
- No merged PRs in 30d
Description
as far as I can tell, there is only one abbreviation TYPES for types templates. I think it might be useful to have separate templates for abstract and concrete types, e.g. one might want to do the following
@template TYPES = """
$(TYPEDEF)
$(DOCSTRING)
## Fields
$(TYPEDFIELDS)
"""
@template ABSTRACTTYPES = """
$(TYPEDEF)
$(DOCSTRING)
"""
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 TYPES template and the template registration or expansion entry point in DocStringExtensions.jl. Check how templates are tested, then define the expected behavior for separate concrete and abstract type templates and add coverage showing each template is selected appropriately.
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