Update badge.md: fix wrong documentation#1419
Update badge.md: fix wrong documentation#1419shinokada merged 1 commit intothemesberg:mainfrom pietervdvn:patch-1
Conversation
I was surprised that `on:dismiss` didn't work. Upon inspecting the code, it turns out it should be `on:close`
|
@pietervdvn is attempting to deploy a commit to the Themesberg Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe change involves updating the documentation for the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- src/routes/docs/components/badge.md (1 hunks)
Additional comments not posted (1)
src/routes/docs/components/badge.md (1)
242-242: LGTM! Ensure consistency of the event name usage.The change from
dismisstocloseimproves clarity. Verify that the new event name is consistently used throughout the documentation and codebase.Run the following script to verify the consistency of the event name usage:
Verification successful
Event name change verified successfully.
The
on:closeevent is consistently used across the codebase in relevant.sveltefiles, aligning with the documentation update. No further action is required.
src/lib/forms/MultiSelect.sveltesrc/lib/alert/Alert.sveltesrc/lib/badge/Badge.svelteScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the usage of the event name `close` in the codebase. # Test: Search for the event name usage. Expect: Only occurrences of the new event name `close`. rg --type svelte -A 5 $'on:close'Length of output: 63
Script:
#!/bin/bash # Description: Verify the usage of the event name `close` in .svelte files. # Test: Search for the event name usage in .svelte files. Expect: Only occurrences of the new event name `close`. rg --glob '*.svelte' -A 5 'on:close'Length of output: 1152
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
2 participants
📑 Description
I was surprised that
on:dismissdidn't work. Upon inspecting the code, it turns out it should beon:close✅ Checks
Summary by CodeRabbit
Badgecomponent documentation to reflect a change in event naming; the event previously known asdismissis now referred to asclose. This adjustment aims to enhance clarity and align with common UI conventions.