DocStringExtensions.jl icon indicating copy to clipboard operation
DocStringExtensions.jl copied to clipboard

Feature request: TYPEDSIGNATURES without output type

Open tomerarnon opened this issue 1 year ago • 1 comments

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.

tomerarnon avatar Oct 05 '23 18:10 tomerarnon

Yes, that's probably doable. It would need to have a similar approach to https://github.com/JuliaDocs/DocStringExtensions.jl/blob/master/src/abbreviations.jl#L43 where the abbreviation type gets a field that can be used to set whether it shows the return type or not. I'm happy to guide the implementation but don't really have the bandwidth to implement it in the short-term myself.

MichaelHatherly avatar Oct 05 '23 19:10 MichaelHatherly