docs: show field precedence with executable Quick Start examples - #77
Open
Gonghan-Princess wants to merge 1 commit into
Open
docs: show field precedence with executable Quick Start examples#77Gonghan-Princess wants to merge 1 commit into
Gonghan-Princess wants to merge 1 commit into
Conversation
Owner
|
Thanks @Gonghan-Princess - overall this looks good |
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.
The Quick Start describes defaults and static fields without showing their JSON output or explaining which source wins when keys overlap. Add visible outputs and an example showing how defaults, format fields, static fields, dictionary messages, and record extras combine in the current implementation.
Enable INFO logging in the shared setup, correct the
defaultsargument name, and add tests that execute the actual Markdown examples in fresh subprocesses and compare their output with the displayed JSON. Add an Unreleased changelog entry.Refs #36. This addresses the examples and field-precedence portion of the issue.
Validation:
importconfiguration; no dependency or configuration changes are included here.AI assistance: This contribution was prepared with OpenAI Codex, including drafting, implementation, and local verification.