fix: Add missing hyphens to @param JSDoc tags in context.ts #7228
+6
−6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes microsoft#7223: API Extractor produces tsdoc-param-tag-missing-hyphen warnings Added hyphens between parameter names and descriptions in @param JSDoc tags for the provide() and defineProperty() methods to comply with TSDoc standards.
kl2400033266
requested review from
chrisdholt,
janechu and
radium-v
as code owners
Collaborator
|
Hi, thanks for contributing! Can you please update your PR to include change files, and format the PR description to use the provided template content? You may also see additional API Extractor warnings for other packages in the repo, which would be nice to include fixes for here. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #7223: API Extractor produces tsdoc-param-tag-missing-hyphen warnings
Added hyphens between parameter names and descriptions in @param JSDoc tags for the provide() and defineProperty() methods to comply with TSDoc standards.
Pull Request
📖 Description
🎫 Issues
👩💻 Reviewer Notes
📑 Test Plan
✅ Checklist
General
$ npm run change⏭ Next Steps