refactor: using another markdown syntax for this one #3639
Conversation
This file contains 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
mfranzke
added
🐛bug
github-actions
bot
added
🏘components
This reverts commit 4e3b957.
…transformed-to-ul-html-element
nmerget
approved these changes
Jan 6, 2025
…transformed-to-ul-html-element
There was a problem hiding this comment.
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 |
| */ | ||
| primaryAction?: any; | ||
| /** | ||
| * Slot to pass one or more elements like DBButton (e.g. profile, language, etc.) as secondary action. | ||
| * Desktop: Shown seperated by divider at the end of the header | ||
| * Mobile: Shown inside the drawer at the bottom. | ||
| * - Desktop: Shown seperated by divider at the end of the header |
There was a problem hiding this comment.
The word 'seperated' is misspelled. It should be 'separated'.
Suggested change
| * - Desktop: Shown seperated by divider at the end of the header | |
| * - Desktop: Shown separated by divider at the end of the header |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
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.
Proposed changes
Resolves https://github.com/db-ui/mono/issues/3360
Types of changes
Further comments