refactor(plugin-photo-swipe): add jsdoc and improve docs #508
+225
−70
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive JSDoc comments across plugin code and refines both Chinese and English documentation for consistency and clarity.
- Added JSDoc annotations to plugin, client utilities, and composables
- Updated inline comments, improved parameter descriptions, and provided usage examples
- Refined Chinese and English markdown docs, corrected typos, and harmonized phrasing
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| plugins/features/plugin-photo-swipe/src/node/photoSwipePlugin.ts | Added JSDoc for the main plugin function |
| plugins/features/plugin-photo-swipe/src/node/options.ts | Adjusted doc comments punctuation |
| plugins/features/plugin-photo-swipe/src/node/locales.ts | Updated plugin description header |
| plugins/features/plugin-photo-swipe/src/client/utils/createPhotoSwipe.ts | Added JSDoc for state interface and factory |
| plugins/features/plugin-photo-swipe/src/client/typings.ts | Added interface documentation |
| plugins/features/plugin-photo-swipe/src/client/helpers/photo-swipe.ts | Documented types and helpers |
| plugins/features/plugin-photo-swipe/src/client/composables/usePhotoSwipe.ts | Added JSDoc for composable and options |
| docs/zh/plugins/features/photo-swipe.md | Improved Chinese docs, fixed typos, and updated examples |
| docs/plugins/features/photo-swipe.md | Improved English docs, fixed typos, and updated examples |
| .github/copilot-instructions.md | Added instructions to ignore VuePress-specific grammar errors |
Comments suppressed due to low confidence (3)
docs/zh/plugins/features/photo-swipe.md:100
- The locale key
arrowPrevdoes not align with thePhotoSwipePluginLocaleDataproperty (likelyprev). Please rename it back toprevor update the interface to match.
arrowPrev: string
docs/plugins/features/photo-swipe.md:105
- The locale key
arrowNextdoes not align with thePhotoSwipePluginLocaleDataproperty (likelynext). Please rename it back tonextor update the interface accordingly.
arrowNext: string
docs/zh/plugins/features/photo-swipe.md:175
- The frontmatter field
photoSwipemay be incorrect if the plugin expectsphotoswipe(all lowercase). Ensure the key matches the code’s option name to prevent configuration mismatches.
### photoSwipe
Pull Request Test Coverage Report for Build 15435449869Details
💛 - Coveralls |
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.
No description provided.