Skip to content
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

Fix formatting in component docs #185

Merged
merged 2 commits into from
Oct 5, 2023
Merged

Fix formatting in component docs #185

merged 2 commits into from
Oct 5, 2023

Conversation

simu
Copy link
Member

@simu simu commented Oct 5, 2023

Checklist

  • The PR has a meaningful title. It will be used to auto generate the
    changelog.
    The PR has a meaningful description that sums up the change. It will be
    linked in the changelog.
  • PR contains a single logical change (to build a better changelog).
  • Update the documentation.
  • Categorize the PR by adding one of the labels:
    bug, enhancement, documentation, change, breaking, dependency
    as they show up in the changelog.

@simu simu added the documentation Improvements or additions to documentation label Oct 5, 2023
@simu simu requested a review from a team as a code owner October 5, 2023 08:19
@simu simu force-pushed the docs/fix-formatting branch from 592bd37 to 6d8bab5 Compare October 5, 2023 08:21
Copy link
Member

@haasad haasad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Result looks good, although I don't fully understand why escaping \* is sometimes required and sometime isn't

@simu
Copy link
Member Author

simu commented Oct 5, 2023

Result looks good, although I don't fully understand why escaping \* is sometimes required and sometime isn't

I experimented locally until the formatting looked good. As far as I can tell, you need to escape the first * of a pair when there's multiple in a single paragraph.

@simu simu merged commit f96735b into master Oct 5, 2023
24 checks passed
@simu simu deleted the docs/fix-formatting branch October 5, 2023 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants