JuliaDocs / JuliaDocs/DocStringExtensions.jl
SIGNATURES in composite type definition
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
I wonder if it would it make sense to allow
"""
$(SIGNATURES)
"""
Base.@kwdef struct Foo
a
b
end
document the constructors of Foo. This would be especially useful when there is not other explicit outer or inner constructor.
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
The issue provides a Julia example using SIGNATURES with Base.@kwdef struct Foo; start by locating the SIGNATURES entry point and examining how this composite-type case is handled. Define the expected documented constructors for Foo, including the case with no explicit outer or inner constructor, and add coverage for that behavior.
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