Skip to content

feat(lib): add man_lib, pydantic model to parameter-doc introspection - #342

Open
speriaswamy-amd wants to merge 1 commit into
speriaswamy/cvsman-08-preflight-schemafrom
speriaswamy/cvsman-09-man-lib
Open

feat(lib): add man_lib, pydantic model to parameter-doc introspection#342
speriaswamy-amd wants to merge 1 commit into
speriaswamy/cvsman-08-preflight-schemafrom
speriaswamy/cvsman-09-man-lib

Conversation

@speriaswamy-amd

Copy link
Copy Markdown
Contributor

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 the
pydantic schemas that actually validate the config. man_lib introspects a
pydantic model directly so documentation is generated from the single source
of truth instead of hand-maintained in parallel.

What changed

  • Added 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.
  • Added cvs/lib/unittests/test_man_lib.py covering discovery, nesting,
    required/default/constraint reporting, alias handling, and both render
    formats — built against local toy models, independent of the real schemas.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant