Skip to content

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

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

mfranzke
Copy link
Collaborator

@mfranzke mfranzke commented Jan 3, 2025

Proposed changes

Resolves #3360

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (fix on existing components or architectural decisions)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Further comments

@mfranzke mfranzke added 🐛 bug Something isn't working 📕 documentation Improvements or additions to documentation labels Jan 3, 2025
@mfranzke mfranzke self-assigned this Jan 3, 2025
Copy link
Contributor

github-actions bot commented Jan 3, 2025

@github-actions github-actions bot added 🧱 components Changes inside components folder and removed 📕 documentation Improvements or additions to documentation labels Jan 3, 2025
nmerget
nmerget previously approved these changes Jan 6, 2025
@mfranzke mfranzke marked this pull request as draft January 6, 2025 07:59
@mfranzke mfranzke requested review from Copilot and removed request for bruno-sch March 28, 2025 14:37
Copy link

@Copilot Copilot AI left a 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 bug Something isn't working 🧱 components Changes inside components folder
Projects
Status: 🏗 In development
Development

Successfully merging this pull request may close these issues.

docs: markdown list structure not being transformed to ul HTML element
2 participants