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(docs): escape backticks in type or default value columns #6025

Merged

Conversation

brandongregoryscott
Copy link
Contributor

What is the current behavior?

fixes #6024

What is the new behavior?

Types or default values that include a backtick are escaped with two backticks and a space.

Documentation

Does this introduce a breaking change?

  • Yes
  • No

Testing

See the new unit tests in markdown-props.spec.ts. If you think the logic for this bug fix should exist somewhere else, let me know!

Other information

Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

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

Nice 👍 LGTM

@brandongregoryscott
Copy link
Contributor Author

Ah, looks like some tests are failing. Let me fix those up, running the whole suite was tanking my laptop.

@christian-bromann christian-bromann added this pull request to the merge queue Oct 11, 2024
Merged via the queue into stenciljs:main with commit 009d370 Oct 11, 2024
88 checks passed
@christian-bromann
Copy link
Member

This was released with @stencil/[email protected]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Template literal type props are not escaped properly in generated markdown
2 participants