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

TYPEDEF does not show type parameters for abstract types. #104

Closed
lassepe opened this issue Nov 19, 2020 · 1 comment · Fixed by #105
Closed

TYPEDEF does not show type parameters for abstract types. #104

lassepe opened this issue Nov 19, 2020 · 1 comment · Fixed by #105

Comments

@lassepe
Copy link
Contributor

lassepe commented Nov 19, 2020

TYPEDEF ommits type parameters of abstract types. E.g.

using DocStringExtensions: TYPEDEF

"""
$(TYPEDEF)
"""
abstract type MyAbstractType{T} end

Will result in the following (REPL) documentation:

help?> MyAbstractType
  abstract type MyAbstractType
@MichaelHatherly
Copy link
Member

MichaelHatherly commented Nov 19, 2020

Sounds fine to me, pretty sure this used to work, though that was pre-1.0 days... probably pretty easy to add. Have a look at https://github.com/JuliaDocs/DocStringExtensions.jl/blob/master/src/abbreviations.jl#L484-L538. Should just need some print_params(buf, object) added to those methods. Feel free to open a PR if you have the time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants