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 encoding and syntax highlighting of example code #2175

Merged
merged 2 commits into from
Oct 9, 2024

Conversation

emlun
Copy link
Member

@emlun emlun commented Oct 2, 2024

Using <pre> sometimes causes some characters to be converted into others. This is especially apparent in CDDL examples, where for example the first single quote in foo = h'001122' gets converted into "’" (U+2019) instead of "'" (U+0027), which is incorrect and also breaks CDDL syntax highlighting.

This PR also fixes the syntax highlighting tags on some incorrectly tagged or untagged examples.

See the Bikeshed documentation for more on using <xmp>.


Preview | Diff

Using `<pre>` sometimes causes some characters to be converted into others. This
is especially apparent in CDDL examples, where for example the first single
quote in `foo = h'001122'` gets converted into "’" (U+2019) instead of
"'" (U+0027), which is incorrect and also breaks CDDL syntax highlighting.

See the [Bikeshed documentation][1] for more on using `<xmp>`.

[1]: https://speced.github.io/bikeshed/#xmp
@emlun emlun self-assigned this Oct 2, 2024
@emlun emlun added this to the L3-WD-02 milestone Oct 2, 2024
Copy link
Contributor

@selfissued selfissued left a comment

Choose a reason for hiding this comment

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

Approved during the 9-Oct-24 call

@selfissued selfissued merged commit cfa7333 into main Oct 9, 2024
2 checks passed
github-actions bot added a commit that referenced this pull request Oct 9, 2024
SHA: cfa7333
Reason: push, by selfissued

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@emlun emlun deleted the example-code-xmp branch October 28, 2024 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants