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

[Docs]: Some React element names are hidden when hovering over symbol in VS Code editor #10872

Closed
ayushmanchhabra opened this issue Sep 16, 2023 · 2 comments · Fixed by #10874
Labels

Comments

@ayushmanchhabra
Copy link
Contributor

ayushmanchhabra commented Sep 16, 2023

Describe what's incorrect/missing in the documentation

This happens when the React element defined as <Element> in multi line comment sections are not surrounded by backticks. In the screenshot above, the missing element name is <Link> which is here.

Without backticks:
React Router SS

With backticks:
React Router SS 2

I was going to open a PR for useNavigate but I realised there must be more of these across the codebase. I can probably use a regex (similar to ^\*(.*) <(.*)>) to find all the incorrectly named elements. Looking for feedback on how to go about it. One big PR or multiple small ones and use this as a tracking issue?

Update:

Ended up creating one PR since patch was not that big.

@github-actions
Copy link
Contributor

🤖 Hello there,

We just published version 6.17.0-pre.0 which involves this issue. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

@github-actions
Copy link
Contributor

🤖 Hello there,

We just published version 6.17.0 which involves this issue. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

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

Successfully merging a pull request may close this issue.

2 participants