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

3.13.0 removes support for @typeParam docstrings #326

Closed
thomasballinger opened this issue Jul 20, 2022 · 6 comments
Closed

3.13.0 removes support for @typeParam docstrings #326

thomasballinger opened this issue Jul 20, 2022 · 6 comments

Comments

@thomasballinger
Copy link

It looks like typedoc-plugin-markdown 3.13.0 removes support for type parameter comments:
f39318e#diff-7f67abb76184a8f36fc1d88d18a6dbd4f9f6c0a4c6ed5826a473da8556990a40R47-R51

Know what's up with this, is this intended?

@thomasballinger
Copy link
Author

thomasballinger commented Jul 20, 2022

The comments seem to get lost somewhere in
https://github.com/tgreyuk/typedoc-plugin-markdown/blob/0615f05f02b5f6100c2a1959f6cae346086d70f7/packages/typedoc-plugin-markdown/src/resources/helpers/type-parameter-table.ts#L59-L63
in the codebase I'm working in, but in the test that parses

https://github.com/tgreyuk/typedoc-plugin-markdown/blob/0615f05f02b5f6100c2a1959f6cae346086d70f7/test/stubs/src/generics.ts#L13-L22

in the repo the comments aren't on the TypeParameterReflection object at all when the table helper runs.

@thomasballinger
Copy link
Author

Upgrading typedoc from 0.23.2 to 0.23.8 restores the comments at project.getChildByName('functionWithTypeParams').signatures[0].typeParameters[0].comment,
at which point the issue becomes the Handlebars.helpers.returns(parameter.comment) referenced earlier.

@thomasballinger
Copy link
Author

I'm missing some context on the changes that happened in f39318e, but if this can keep being comments instead of returns then this seems to work.

tgreyuk added a commit that referenced this issue Jul 20, 2022
@tgreyuk
Copy link
Member

tgreyuk commented Jul 20, 2022

Thanks - not too sure what happened there. Will update when fix is released.

@tgreyuk
Copy link
Member

tgreyuk commented Jul 21, 2022

Fix in typdoc-plugin-markdown@3.13.4

@thomasballinger
Copy link
Author

Thanks a lot, really appreciate the quick fix!

@tgreyuk tgreyuk closed this as completed Jul 21, 2022
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

Successfully merging a pull request may close this issue.

2 participants