-
Notifications
You must be signed in to change notification settings - Fork 236
feat(docs): Render argparse metadata as semantic definition list #1011
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
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
Replace inline pipe-separated metadata (Default: None | Type: str | Required) with a semantic <dl> structure that enables independent CSS styling of keys, values, and tags. Uses Furo's guilabel pattern for Required tag with semi-transparent amber background for light/dark mode compatibility.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1011 +/- ##
=======================================
Coverage 80.11% 80.11%
=======================================
Files 28 28
Lines 2409 2409
Branches 457 457
=======================================
Hits 1930 1930
Misses 356 356
Partials 123 123 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Standardize font-size across CLI inline roles, usage blocks, argument names, and metadata to use Furo's --code-font-size variable (81.25%) for consistent sizing with other code elements.
tony
added a commit
that referenced
this pull request
Jan 25, 2026
b93d34f to
45232b5
Compare
Lowercase metavars like `socket_name` were split at underscores because the regex `[a-z][-a-z0-9]*` didn't include `_`. Changed to `[a-z][-a-z0-9_]*` in all 6 pattern locations. Fixes: tmuxp load usage showing `<span>socket</span>_name` instead of `<span>socket_name</span>`.
Furo's "auto" theme follows system prefers-color-scheme. The meta tag dark styling only targeted explicit data-theme="dark", missing the auto-dark case where body:not([data-theme="light"]) applies.
The light mode override for headerlink colors used body:not([data-theme="dark"]) which incorrectly matches auto mode even when system is dark. Split into explicit light selector plus media query for auto + system light.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Default: None | Type: str | Required) with semantic<dl>definition list structurevar(--code-font-size)for consistent sizingChanges
HTML structure (before):
HTML structure (after):
Font size standardization:
.cli-option,.cli-metavar, etc.)pre.argparse-usage).argparse-argument-name).argparse-meta-key,.argparse-meta-value,.argparse-meta-tag)All now use
var(--code-font-size)(Furo's 81.25%) for consistency with other code elements.Test plan
/cli/edit.htmlin light and dark modes