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

Description of all JSDoc tags except @param in hovers shows [object Object] #2523

Closed
spahnke opened this issue Jun 11, 2021 · 2 comments · Fixed by microsoft/monaco-typescript#81
Labels
bug Issue identified by VS Code Team member as probable bug typescript

Comments

@spahnke
Copy link
Contributor

spahnke commented Jun 11, 2021

monaco-editor version: 0.25.0
Browser: Edge 91
OS: Windows 10
Playground code that reproduces the issue:

/** @deprecated Use `bar()` instead */
function foo(){}

If you hover over a symbol that is marked with @deprecated in JSDoc or use the suggest widget, the deprecated field in the markdown shows [object Object]. The same is true for all other tags except @param.
grafik

@param definitions seem to work fine
grafik

@spahnke
Copy link
Contributor Author

spahnke commented Jun 11, 2021

@orta seems to have added handling for the @param case where tag.text is an array.
https://github.com/microsoft/monaco-typescript/pull/75/files#diff-ea95b2efb3fd38940772369b9ec8a70e76d7a0f40d570f1056a4a054eccfb951

It seems like we need the same handling for all other tags here:
https://github.com/microsoft/monaco-typescript/blob/3fb5fa051e0afd1fbc215d047bb5d9995d25b947/src/languageFeatures.ts#L579

Maybe we should check if tag.text is an array, or is this now always guaranteed to be an array (the typings suggest that it is)?

@alexdima alexdima added bug Issue identified by VS Code Team member as probable bug typescript labels Jun 11, 2021
@spahnke spahnke changed the title @deprecated hover shows [object Object] Description of all JSDoc tags except @param in hovers shows [object Object] Jun 11, 2021
@spahnke
Copy link
Contributor Author

spahnke commented Jun 18, 2021

@hediet Could the fix for this in monaco-typescript be included in the next update? Thank you! 🙇‍♂️

@github-actions github-actions bot locked and limited conversation to collaborators Jan 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Issue identified by VS Code Team member as probable bug typescript
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants