Repository navigation
Conversation
A code span followed by a letter - `type_id`s, `virtual_ptr`s, `dlopen`s - is passed by MrDocs to AsciiDoc as is, where a constrained span cannot end inside a word: the backticks come through literally, and the next code span in the paragraph loses its formatting (`nullptr` in operator== and operator!=). Reworded: "type ids", "`virtual_ptr` objects", "uses `dlopen` to load". The same scan of the rendered reference found three other broken spans, fixed too: a missing opening backtick (IsPolymorphic), two missing closing ones (virtual_ptr's converting constructor and assignment), and three spans split across two `//!` lines (boost_openmethod_registry, virtual_any, the intrusive_ptr virtual_traits). CLAUDE.md: document the plural trap among the doc-comment markup traps, with a grep. A possessive is safe in a doc comment: MrDocs writes the apostrophe as '. After the change, no rendered page has a backtick outside a code block. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
An automated preview of the documentation is available at https://128.openmethod.prtest3.cppalliance.org/libs/openmethod/doc/html/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-10-06 23:18:25 UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #128 +/- ##
========================================
Coverage 92.34% 92.34%
========================================
Files 27 27
Lines 2234 2234
Branches 679 679
========================================
Hits 2063 2063
Misses 112 112
Partials 59 59
Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
This branch has not been deployed
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
2 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.
(Written by Claude Code, on behalf of @jll63.)
The rendered reference had code spans that came out with literal backticks, sometimes taking the formatting of the next span with them.
`type_id`s,`virtual_ptr`s,`dlopen`sinvptr_map,vptr_vector,minimal_perfect_hash,std_rtti::type_index, andoperator==/operator!=. In those two operators,nullptralso lost its formatting. MrDocs passes the span to AsciiDoc as is, where a constrained span cannot end inside a word. Reworded: "type ids", "virtual_ptrobjects", "usesdlopento load".IsPolymorphic).virtual_ptr's converting constructor and assignment).//!lines (boost_openmethod_registry,virtual_any, theintrusive_ptrvirtual_traits).CLAUDE.md documents the plural trap among the doc-comment markup traps, with a grep to run before building. A possessive is safe in a doc comment, because MrDocs writes the apostrophe as
'.Verified by building the docs: no rendered page has a backtick outside a code block, and no MRDOCS leak. The changes are comment-only, and clang-format leaves them unchanged.
🤖 Generated with Claude Code