JuliaDocs / JuliaDocs/DocStringExtensions.jl
destructuring in SIGNATURES show #temp
Open
Nobody has claimed this yet.
Status: Available
Type: Enhancement
- Dominant language
- Julia
- Stars
- 126
- Forks
- 35
- PR merge metrics
- No merged PRs in 30d
Description
julia> using DocStringExtensions
julia> """
$(SIGNATURES)
This function destructures!
"""
function f((x, y))
x + y
end
f
julia> @doc f
f(#temp#)
This function destructures!
julia> VERSION
v"1.0.1-pre.0"
it would be nice to have f((x, y)).
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
Reproduce the issue with the Julia example using SIGNATURES and @doc f, checking the displayed signature for the destructured argument. Trace how SIGNATURES handles the function definition and verify that the documentation output becomes f((x, y)) rather than f(#temp#).
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100