docs(readme): use <code> in <summary> for function and type names#12
Merged
Conversation
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
1 participant
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.
Summary
Use
<code>instead of<em>inside<summary>tags across every<details>block in the API docs (functions and types). Function and type names render as code identifiers — the italic was visually marketing-ish where the rest of the document carries technical density. Surgical: only<summary>content changes; descriptions, tables, Returns / Throws / Examples, anchors, andbench/baseline.mdreference are untouched.Part of a Coroboros-wide doc alignment so
uri/clone/sparkline/location-timezoneall use the same per-method block format.Test plan
<em>text).<details>blocks fold and unfold correctly on GitHub.