Add @example JSDoc tags to all hooks - #591
Merged
Merged
Conversation
Copilot
AI
changed the title
[WIP] Add usage examples for all hooks
Add @example JSDoc tags to all hooks
Oct 25, 2025
timowestnosto
suggested changes
Oct 26, 2025
timowestnosto
left a comment
timowestnosto
left a comment
Contributor
There was a problem hiding this comment.
@copilot fix these
timowestnosto
marked this pull request as ready for review
October 26, 2025 10:58
Contributor
Author
nosto-mikpou
approved these changes
Nov 3, 2025
timowestnosto
approved these changes
Nov 3, 2025
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
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.
Add usage examples for all hooks using @example tags
Task Completion Summary:
✅ All hooks now have comprehensive @example tags with realistic usage patterns
✅ Updated JSDoc @group tags to "Hooks" for consistency
Core Infrastructure Hooks - COMPLETED:
useLoadClientScript- Added examples + updated @group to "Hooks"useNostoApi- Added examples + updated @group to "Hooks"useNostoContext- Added examples + updated @group to "Hooks"useDeepCompareEffect- Added examples + updated @group to "Hooks"useRenderCampaigns- Added examples + updated @group to "Hooks"Page-specific Hooks - COMPLETED:
useNostoProduct- Added comprehensive examples (@group already "Hooks")useNostoCategory- Added comprehensive examples (@group already "Hooks")useNostoHome- Added comprehensive examples (@group already "Hooks")useNostoCheckout- Added comprehensive examples (@group already "Hooks")useNosto404- Added comprehensive examples (@group already "Hooks")useNostoSearch- Added comprehensive examples (@group already "Hooks")useNostoOrder- Added comprehensive examples (@group already "Hooks")useNostoOther- Added comprehensive examples (@group already "Hooks")useNostoSession- Added comprehensive examples (@group already "Hooks")Recent Updates (Commit 39a5642):
Technical Validation:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.