Add embedded docs layout to widen parameter descriptions (closes #26) - #46
Merged
magnesj merged 1 commit intoJun 25, 2026
Merged
Conversation
Closes #26. Keywords with many parameters (e.g. WECON) squeezed the Description column down to a few characters. Add an "embedded" layout — now the default — that folds the Type, unit, and Default values into a muted sub-line beneath each description, freeing the full width for the description text. - New opm-flow.docs.layout setting ("embedded" | "columns", default "embedded"). The existing Type/unit/Default show-hide flags still control which values appear in either layout. - Shared metaBits() builder with HTML and markdown renderers, applied to both the docs sidebar and the hover tooltip. The original column layout is preserved under "columns".
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.
Closes #26 — implements @pkirkham's suggestion from #26 (comment).
Problem
Keywords with many parameters (e.g.
WECON) squeeze the Description column down to a few characters, making the docs hard to read.Fix
Add an
embeddeddocs layout — now the default — that folds the Type, unit, and Default values into a compact, muted sub-line beneath each parameter description, freeing the full table width for the description text.A row now reads like:
Details
opm-flow.docs.layoutsetting ("embedded"|"columns", default"embedded"). The existing Type / unit / Default show-hide settings still control which values appear in either layout, so users who prefer the original grid can set"opm-flow.docs.layout": "columns".metaBits()builder with HTML and markdown renderers, applied to both the docs sidebar and the hover tooltip for consistency..metastyling; multi-record tables and cursor-driven row highlighting are unchanged.Verification
package.jsonvalidated as JSON.extension.ts(not unit-tested, consistent with the existingbuildDocsHtml); best checked by hovering a wide keyword likeWECONin the running extension.🤖 Generated with Claude Code