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: fix invalid jsdoc comments #10241

Merged
merged 1 commit into from
Sep 25, 2022
Merged

docs: fix invalid jsdoc comments #10241

merged 1 commit into from
Sep 25, 2022

Conversation

shigma
Copy link
Contributor

@shigma shigma commented Sep 25, 2022

Description

Fix invalid jsdoc comments.

Additional context

Tags will be rendered as empty string in IDE.

Before:

image

After:

image


What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines and follow the Commit Convention.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

@bluwy bluwy changed the title fix: fix invalid jsdoc comments docs: fix invalid jsdoc comments Sep 25, 2022
@bluwy bluwy merged commit 9acb839 into vitejs:main Sep 25, 2022
@bluwy
Copy link
Member

bluwy commented Sep 25, 2022

Thanks!

@shigma shigma deleted the fix-comments branch September 25, 2022 15:09
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 this pull request may close these issues.

2 participants