JuliaDocs / JuliaDocs/DocStringExtensions.jl
Feature request: TYPEDSIGNATURES without output type
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 126
- Forks
- 35
- PR merge metrics
- No merged PRs in 30d
Description
As mentioned in the original typedsignatures issue: https://github.com/JuliaDocs/DocStringExtensions.jl/issues/20#issuecomment-461420993
generic julia code often doesn't have a definite return type. Would it be possible to either customize TYPEDSIGNATURES to omit this (or create a new behavior) to show input type annotations while omitting any inferred output types? As it is, I have very many f(x) -> Any signatures in my documentation, which is misleading since they are actually type stable.
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 reading the TYPEDSIGNATURES implementation and the linked discussion in issue 20 to understand how input and inferred output types are currently rendered. Define whether omitting output types should be a configurable option or a new behavior, then add coverage for signatures such as f(x) -> Any and verify the generated documentation matches the intended display.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100