docs: fix watcher field-registration pattern across all docs#102
Merged
Conversation
All three docs (quickstart, watching, async) showed watcher.field() called inside the context manager block, which raises RuntimeError at runtime. The implementation enforces field registration before start() / __enter__. Unified on the canonical two-step pattern: create watcher, register fields, then enter the context manager. Also removed the contradictory "Or equivalently" block and confusing "Wait —" note from watching.md Lifecycle section, and fixed the Multiple watchers example which had the same error. Closes #65 Co-Authored-By: Claude <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
1 participant
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.
Summary
field()called inside the context manager block, which raisesRuntimeErrorat runtime — the implementation enforces registration beforestart()/__enter__.watching.md, and fixed the Multiple watchers example.Test plan
sdk/docs/quickstart.md— watcher example registers fields beforewith watcher:sdk/docs/watching.md— Basic usage, Lifecycle, and Multiple watchers all use correct pattern; no contradictory notesdk/docs/async.md— both examples register fields beforeasync with watcher:watcher.py:146—field()raisesRuntimeErrorif_thread is not NoneCloses #65