docs: extend README adventures (input editing, gates demo, private schema) + Path fix#16
Open
IanMayo wants to merge 2 commits into
Open
docs: extend README adventures (input editing, gates demo, private schema) + Path fix#16IanMayo wants to merge 2 commits into
IanMayo wants to merge 2 commits into
Conversation
Wrap the input filename in Path(...) so the scratch file type-checks cleanly under Pylance — the builder is annotated to take a Path. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AHAkhfmfcCdWTHZuvRcJNF
…ivate-schema path Fold in the hands-on bits from the PLAYGROUND.md proposal (#12): - Adventure 1: edit examples/calculation_input.xml and re-run; break it on purpose to watch the gate reject invalid input with no stale artifact. - Adventure 2: show serialize.to_xml in the REPL. - Adventure 5 (new): point the CLI at the gitignored private/ real schema via generate/validate/compare, with the caveat that full pipeline imports the committed models. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AHAkhfmfcCdWTHZuvRcJNF
|
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
2 participants
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.
What
Two things in one branch:
Type-clean the autocomplete example — wrap the input filename in
Path(...)inexamples/explore_platform.py, sincebuild_platform_from_fileis annotated to take aPath. Removes a Pylance warning in the shipped learning file. (We chose to keep the builder APIPath-strict rather than widen it.)Extend the README "Self-guided adventures" — fold in the genuinely-missing hands-on material that the open
PLAYGROUND.mdproposal (docs: add PLAYGROUND.md hands-on guide #12) had but our README lacked:examples/calculation_input.xmland re-run to watch the validated output change; then break it on purpose (negative/non-numericBandCount) to see the gate reject it, print the reason, exit non-zero, and write no stale artifact.serialize.to_xml(platform)in the REPL — the same object, as XML.private/real schema (generate/validate/compareagainstprivate/paths), including the caveat thatacoustic pipelineimports the committed models so it can't run end-to-end on real models without a reviewed change.Verification
python examples/explore_platform.pyruns;mypyclean on it.ruff check src testspasses; fullpytestsuite (41 tests) passes.private/is confirmed gitignored; the section avoids referencing files that don't exist yet.🤖 Generated with Claude Code
Generated by Claude Code