Skip to content

Document validating mappings and accessing results by attribute - #219

Open
ac1982 wants to merge 1 commit into
beetbox:mainfrom
ac1982:docs/validated-mapping-access
Open

ac1982 wants to merge 1 commit into
beetbox:mainfrom
ac1982:docs/validated-mapping-access

Conversation

@ac1982

@ac1982 ac1982 commented Oct 14, 2026

Copy link
Copy Markdown

Add a worked example to the usage guide showing how to validate a mapping with one get(template) call and access the resulting nested AttrDict by attribute.

The guide explains required fields versus typed defaults, invalid values, dictionary-method name collisions, and retrieving fresh values after an override. It also shows how to validate a subtree so larger applications can keep validation local to each component.

Fixes #69.

Validation: executed both documentation blocks and checked missing/invalid fields, layered values, key collisions, and refresh behavior. Strict Sphinx HTML build, documentation formatting and lint pass. The full test suite has 300 passes and one existing release-helper failure; the same changelog-underline assertion fails on the unchanged base.

Developed and validated with OpenAI Codex.

This branch has not been deployed

No deployments
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.

Docs: show off "dot notation" attribute access when validating an entire dict at once

1 participant