docs(ui-components): update mark button doc #506
+81
−21
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 GitHub.
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the mark button component documentation by removing the deprecated formattedName return value from the useMark hook and adding comprehensive documentation for the shouldShowButton() utility function.
Key changes:
- Removed all references to
formattedNamefrom hook usage examples and return value tables - Added complete parameter and return type documentation for all utility functions (
canToggleMark,toggleMark,isMarkActive,getFormattedMarkName,shouldShowButton) - Updated import order for consistency
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/content/ui-components/components/mark-button.mdx | Updated hook examples to remove formattedName, added structured documentation for utility functions with parameters and return types, and reorganized imports |
| .changeset/real-eyes-look.md | Changeset documenting the removal of formattedName and addition of shouldShowButton() documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
formattedNameshouldShowButton()utility