Skip to content

docs: define typed user config boundary - #120

Merged
codeforester merged 1 commit into
mainfrom
enhancement/105-20260806-typed-user-config
Aug 6, 2026
Merged

docs: define typed user config boundary#120
codeforester merged 1 commit into
mainfrom
enhancement/105-20260806-typed-user-config

Conversation

@codeforester

Copy link
Copy Markdown
Contributor

Summary

Refs #105.

  • document the intentional opaque Context.user_config: object | None boundary
  • recommend one consumer-owned typed accessor instead of repeated casts
  • define why a fourth Context type parameter is deferred beyond 0.4.x
  • specify the end-to-end design and migration requirements for a possible 0.5.0 generic expansion
  • link the proposal from the consumer-profile docs and README

Validation

  • bash tests/validate.sh
  • python scripts/validate_docs.py
  • python -m pytest -q
  • ruff check lib/python scripts examples tests compatibility

@codeforester
codeforester marked this pull request as ready for review August 6, 2026 03:12
@codeforester
codeforester merged commit f144971 into main Aug 6, 2026
160 of 162 checks passed
@codeforester
codeforester deleted the enhancement/105-20260806-typed-user-config branch August 6, 2026 03:12
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