JuliaDocs / JuliaDocs/DocStringExtensions.jl
Implement SIGNATURES-like abbreviation for collection of methods
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
When I have several methods, for example:
"""
$(SIGNATURES)
Print-fu.
"""
foo(x::Int) = print(x)
foo(x::Int, y::Int) = print(x + y)
I get
foo(x)
Print-fu.
But I am looking for an implementation that yields
foo(x)
foo(x, y)
Print-fu.
Is this possible at all?
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 examining the existing SIGNATURES handling in DocStringExtensions.jl and the Julia docstring example in the issue. Determine how method collections are identified and make the abbreviation expand to one line per method, matching the shown foo(x) and foo(x, y) output; no specific file or test is named.
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