[v2] Improve example validation and corrections#10101
Open
[v2] Improve example validation and corrections#10101
Conversation
kdaily
requested changes
Mar 30, 2026
Member
kdaily
left a comment
kdaily
left a comment
There was a problem hiding this comment.
Great fixes to so many subtle mistakes!
Just a couple minor things.
ashovlin
force-pushed
the
shovlia/docs-validatation
branch
from
01ad3b6 to
dd03205
Compare
kdaily
previously approved these changes
Mar 31, 2026
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
3 participants
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.
Issue #, if available: N/A
Description of changes:
This improves the validation we do in the existing
tests/functional/docs/test_examples.py. Previously we were only testing the service and operation name.Now, it runs the example commands through the appropriate parser for each. This will catch more issues: invalid syntax, invalid argument names, missing required parameters.
This also fixes the examples that fail for the updated test.
Note: I did not address examples that specify
--cli-input-json/etc., it'll require more work to parse and validate those.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.