JuliaDocs / JuliaDocs/DocStringExtensions.jl
what is the recommended way to document arguments used only for their type for SIGNATURES?
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 126
- Forks
- 35
- PR merge metrics
- No merged PRs in 30d
Description
This is not (yet) a feature request, just asking for advice on using this package.
Sometimes the value of an argument is not directly relevant, as the body uses their type. Eg (contrived MWE)
using DocStringExtensions
"""
$(SIGNATURES)
Generate a tuple of the first `3N` odd numbers.
"""
foo(::Val{N}) where N = ntuple(i -> 2 * i - 1, Val(2 * N))
which renders as
foo(_)
Generate a tuple of the first 3N odd numbers.
What is the recommended approach to deal with this?
(Using TYPEDSIGNATURES just gives a docstring without the signature, but maybe that is a separate issue)
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 source file or test is named. Start by reproducing the Julia MWE with SIGNATURES and comparing it with TYPEDSIGNATURES; done means the package has a documented, agreed recommendation for arguments used only through their type.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100