feat: add API documentation links to type files (JSDoc type hints) #191
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
|
Labels have been automatically applied based on the conventional commit types.🏷️ |
Codecov ReportAll modified and coverable lines are covered by tests ✅
@@ Coverage Diff @@
## main #191 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 11 11
Lines 429 439 +10
=========================================
+ Hits 429 439 +10
Continue to review full report in Codecov by Sentry.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request includes several changes to the documentation comments in various utility files across different packages. The changes primarily add references to the documentation URLs for the respective APIs.
Documentation improvements:
packages/clang-format-git-python/src/utils/gitClangFormatPath.js: Added a reference to the documentation URL forclang-format-git-pythonin the comments forgitClangFormatPathandclangFormatGitPythonPath. [1] [2]packages/clang-format-git/src/utils/getGitClangFormatPath.js: Added a reference to the documentation URL forclang-format-gitin the comments forgetGitClangFormatPathandgetClangFormatGitPath. [1] [2]packages/clang-format-git/src/utils/gitClangFormatPath.js: Added a reference to the documentation URL forclang-format-gitin the comments forgitClangFormatPathandclangFormatGitPath. [1] [2]packages/clang-format-node/src/utils/clangFormatPath.js: Added a reference to the documentation URL forclang-format-nodein the comments forclangFormatPathandclangFormatNodePath. [1] [2]packages/clang-format-node/src/utils/getClangFormatPath.js: Added a reference to the documentation URL forclang-format-nodein the comments forgetClangFormatPathandgetClangFormatNodePath. [1] [2]