Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: TYPEDSIGNATURES without output type #159

Open
tomerarnon opened this issue Oct 5, 2023 · 1 comment
Open

Feature request: TYPEDSIGNATURES without output type #159

tomerarnon opened this issue Oct 5, 2023 · 1 comment

Comments

@tomerarnon
Copy link

tomerarnon commented Oct 5, 2023

As mentioned in the original typedsignatures issue: #20 (comment)
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.

@MichaelHatherly
Copy link
Member

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.

@tomerarnon tomerarnon changed the title TYPEDSIGNATURES without output type Feature request: TYPEDSIGNATURES without output type Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants