-
Notifications
You must be signed in to change notification settings - Fork 10
refactor: using another markdown syntax for this one #3639
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
refactor: using another markdown syntax for this one #3639
Conversation
This reverts commit 4e3b957.
…transformed-to-ul-html-element
…transformed-to-ul-html-element
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR refactors inline markdown syntax in code comments to improve clarity in component documentation. It updates the formatting of aria attribute comments and bullet lists across multiple component models.
- Use backticks for aria attribute names in shared models.
- Convert plain text lists into proper markdown bullet lists.
- Update accordion and header component comments accordingly.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
File | Description |
---|---|
packages/components/src/shared/model.ts | Use backticks to format aria attribute names |
packages/components/src/components/notification/model.ts | Convert description list to markdown bullet list |
packages/components/src/components/header/model.ts | Convert description list to markdown bullet list (contains typo) |
packages/components/src/components/accordion/model.ts | Convert description list to markdown bullet list |
Co-authored-by: Copilot <[email protected]>
…transformed-to-ul-html-element
Proposed changes
Resolves #3360
Types of changes
Further comments