Repository navigation
docs: fix keyword and type documentation rendering in Libdoc - #5423
Merged
Merged
Conversation
Record Keyword, Record Keywords and Record Selector arrived in MarketSquare#5413 after MarketSquare#5266 converted the argument tables, so they kept the old table and had no per-argument documentation in Robot Framework 7.5 Libdoc. Single backticks on plain values made Libdoc look for a link target. Without one they rendered as names, not code, and RecordHar's `path` linked to the unrelated Path type. Use double backticks instead. AutoClosingLevel and PlaywrightLogTypes are used only by __init__, and Libdoc builds type link targets from keywords, so they now link to the type anchors explicitly. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
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
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
Docstring-only. With docstrings stripped, the code is identical to
main.Record Keyword,Record KeywordsandRecord Selectorarrived in #5413, after #5266 converted the argument tables, so they missed the conversion:Single backticks ask Libdoc for a link. With no target, a plain value renders as a name instead of code. With a target it links somewhere wrong:
pathinRecordHarlinked to thePathtype.Also in
data_types.py:not_set,omitContent,path,prefers-reduced-motion,reduce,no-preference,library,playwright,pause_at,fast_forward,run_for,resume,node.innerText,node.textContent. The triple-backtick fence in the library intro, which rendered a stray backtick, is now inline code.AutoClosingLevelandPlaywrightLogTypesare used only by__init__, and Libdoc builds type link targets from keywords, so`X`never resolved for them:Evidence
RF 7.5 Libdoc spec,
specdocformat=HTML:<span class="name">values includeduration,width, the values above, a stray`and the two types.After: 8 of 8 arguments documented. The only unresolved name left is
matches, from theassertionenginepackage.Chromium,
docs/Browser.htmlfrominv docs:AutoClosingLevelandPlaywrightLogTypeswere plain text with nothing to click.After: clicking the
AutoClosingLevellink sets the hash and shows the modal background, the same as a Libdoc-generated type link.inv node-build,inv lint-pythonandinv docspass.inv utest: 1542 passed, 2 skipped. Acceptance tests not run locally: no code changed.Merge Danger
Door: two-way
Blast Radius: documentation
Translations see these docstrings as updated at the next release. The explicit type links were checked on RF 7.5. On RF 7.1.1 they were only read in the Libdoc template, which maps
#type-Xto#type-modal-X.🤖 Generated with Claude Code