docs: add hands-on editor-autocomplete step and fix REPL claim#14
Merged
Conversation
The declared-fields payoff is editor (Pylance) autocomplete, not REPL tab-completion. Clarify that REPL completion is a separate readline/ rlcompleter feature and show how to enable it for a session. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AHAkhfmfcCdWTHZuvRcJNF
Add examples/explore_platform.py — a runnable, freely-editable file that builds a typed Platform — and a README step walking through experiencing Pylance autocomplete on it in VS Code. Reframe the REPL completion note as the separate runtime feature it is. 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
Follow-up to the merged #13. Two changes to the README "Self-guided adventures" section, plus a new scratch file:
Correct the autocomplete claim. The original text attributed REPL tab-completion to the fields being declared. That conflated two mechanisms: editor (Pylance) autocomplete is the static, declared-field feature; REPL completion is a separate runtime
readline/rlcompleterintrospection. The text now says this accurately.Add a hands-on editor-autocomplete step. Adventure 2 now opens with a step that has you open a real
.pyfile in VS Code and experience Pylance completing a typedPlatformobject, drilling down attribute by attribute — the genuine payoff of declared fields.New file
examples/explore_platform.py— a small, runnable, freely-editable scratch file that builds a typedPlatform, with a commentedplatform.line ready to trigger autocomplete on, and a couple of print statements so it also runs.Verification
python examples/explore_platform.pyruns and prints the platform type and first band centre frequency.🤖 Generated with Claude Code
Generated by Claude Code