fix: render inline markup correctly in Adoc and HTML#1186
Open
gennaroprota wants to merge 1 commit into
Open
Conversation
ℹ️ InfoNote PR description is missing template sections: Changes, Testing, Documentation. Following the pull request template helps reviewers find rationale, testing notes, and docs status quickly. ✨ Highlights
🧾 Changes by Scope
🔝 Top Files
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1186 +/- ##
========================================
Coverage 83.16% 83.16%
========================================
Files 35 35
Lines 3658 3658
Branches 843 843
========================================
Hits 3042 3042
Misses 409 409
Partials 207 207
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
An automated preview of the documentation is available at https://1186.mrdocs.prtest2.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-06-25 08:51:01 UTC |
gennaroprota
force-pushed
the
fix/restore_em_mark_sub_sup_del_in_html_output
branch
from
f0c0ddb to
35d81dc
Compare
gennaroprota
force-pushed
the
fix/restore_em_mark_sub_sup_del_in_html_output
branch
from
35d81dc to
15094a7
Compare
Collaborator
|
This is really nice. I think it's going to need a rebase because a few kinds of inline comments have already been fixed since then. We'll also need the examples for the new reference pages that didn't exist 40 days ago. |
Emphasis, subscript, and superscript in doc comments rendered incorrectly. Their common partials all delegated to the italic fallback `markup/i`. In AsciiDoc that yields italics: right for emphasis, wrong for subscript and superscript, which should be lowered and raised. In HTML `markup/i` has no counterpart, so emphasis collapsed to bare text; and the HTML inline dispatcher was a hardcoded list that omitted subscript and superscript, dropping them altogether. Doc comments may now also use the HTML-tag form for the inline-formatting kinds (`<strong>`, `<mark>`, `<del>`, `<s>`, `<sub>`, `<sup>`), joining the previously-supported `<em>`. This is what most users reach for when they need tight notation (e.g. `H<sub>2</sub>O`); the Markdown-marker forms require whitespace flanks, which makes compact chemistry and math notation awkward. Footnote-reference, image, and math share the same italic-fallback rendering but each needs its own design decision and is left for separate fixes. Closes issue cppalliance#1185.
gennaroprota
force-pushed
the
fix/restore_em_mark_sub_sup_del_in_html_output
branch
from
15094a7 to
a14d2e6
Compare
gennaroprota
changed the title
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Note: Rebased onto current develop, where highlight and strikethrough already rendered correctly, so this PR now covers the remaining three kinds. It also documents subscript and superscript in the inline-commands reference with runnable examples.
Five kinds of inline markup in doc comments (emphasis, highlight, subscript, superscript, and strikethrough) were not rendered correctly:
Both rendering paths now produce semantically appropriate markup:
<em>,<mark>,<sub>,<sup>,<del>in HTML, and the matching constructs in AsciiDoc (with strikethrough using the role-based[.line-through]#...#, since AsciiDoc has no native syntax for it).Doc comments may now also use the HTML-tag form for these kinds (
<strong>,<mark>,<del>,<s>,<sub>,<sup>) alongside the previously-supported<em>. This is what most users reach for when they need a tight notation (e.g.,H<sub>2</sub>O); the Markdown-marker forms (~text~,^text^,==text==,~~text~~) require whitespace flanks, which makes compact chemistry/math notation awkward.Three other inline kinds (footnote-reference, image, and math) suffer from the same rendering issue but each requires its own non-trivial design decision and is left for separate fixes.
Closes issue #1185.