feat(lib): add man_lib, pydantic model to parameter-doc introspection - #342
Open
speriaswamy-amd wants to merge 1 commit into
Open
feat(lib): add man_lib, pydantic model to parameter-doc introspection#342speriaswamy-amd wants to merge 1 commit into
speriaswamy-amd wants to merge 1 commit into
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
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.
Part 9 of 14 in a stack for AIMVT-276.
Base: #341.
Why
Config parameter docs currently live only in scattered
_comment_*/_example_*JSON keys and prose READMEs, both of which drift from thepydantic schemas that actually validate the config.
man_libintrospects apydantic model directly so documentation is generated from the single source
of truth instead of hand-maintained in parallel.
What changed
cvs/lib/man_lib.py: walks a pydantic model's fields recursively(including nested models, lists of models, and dict-of-model containers),
and renders the result as human-readable text or JSON. Supports querying a
specific parameter or section by name.
cvs/lib/unittests/test_man_lib.pycovering discovery, nesting,required/default/constraint reporting, alias handling, and both render
formats — built against local toy models, independent of the real schemas.