Repository navigation
feat(libdoc): read specversion 4 (Robot Framework 7.5) - #15
Merged
Merged
Conversation
The 20.6.0 import failed: fetch-libdoc.sh floors RF at 7.4, uv picked 7.5, and its Libdoc writes specversion 4, which the transform rejected. Spec 4 lifts each keyword's `Arguments:` list out of `doc` into the arguments' own `doc`, and the return section into `returnDoc`. Only bumping the version would have dropped every argument description from the reference without an error. Both versions are now accepted: - arguments and returns carry their own sanitized doc, rendered as a row under each argument and under Returns - a `None` return type (spec 4) means no return value, as `null` did in spec 3, in the transform and in the release PR's keyword diff - the build's shrink guard counts argument and return docs too 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.
Fixes the failing Library release run for Browser 20.6.0.
Why it failed
scripts/fetch-libdoc.shfloors Robot Framework at>=7.4, so uv picked the newly released RF 7.5. Its Libdoc writesspecversion: 4, andtransformrejects anything but 3.What spec 4 changes
Diffing Browser 20.6.0 generated with RF 7.4.1 and RF 7.5: no keys removed, counts identical, but
Arguments:list is lifted out ofdocintoargs[].doc(144 of 152 keywords), and the return section intoreturnDocreturnTypeis aNonenode where spec 3 wrotenullaliason type nodes andraiseson keywords are new, always empty in BrowserOnly bumping the version would have silently dropped every argument description from the reference.
Changes
lib/libdoc.tsaccepts specversions 3 and 4; arguments and returns carry their own sanitized, link-rewritten doc (empty for spec 3, which keeps it in the body)KeywordPanels.server.vuerenders an argument's doc as a row under it, and the return doc under ReturnsNonereturn type means no return value, in the transform and inkeyword-diff.ts(which would otherwise reportNone → None)Verified
Nonediff case written first and seen failing; full suite passes (732)🤖 Generated with Claude Code