fix: align handoff/review behavior with refreshed docs - #279
Merged
Conversation
Ruari-Phipps
force-pushed
the
ruari/docs/update_install_route
branch
from
August 19, 2026 13:58
4960231 to
68e3102
Compare
This comment has been minimized.
This comment has been minimized.
- Omit sip_headers from serialized handoff YAML when empty, matching its documented optional status - Return a JSON error from poly review delete --json when no gist ID is given, instead of falling through to an interactive prompt
Ruari-Phipps
force-pushed
the
ruari/docs/update_install_route
branch
from
August 19, 2026 17:19
68e3102 to
f7c6a69
Compare
Contributor
Coverage Report
Changed file coverage
|
Wiz1991
approved these changes
Aug 26, 2026
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.
Summary
Two small code fixes discovered while writing the resource and CLI reference docs, so behavior matches what's now documented. Stacked on #278 — this PR's diff is just the files below once that one merges.
Motivation
Auditing
handoffs.mdandreference/cli/review.mdagainst source surfaced two spots where actual behavior didn't match what a reasonable reading of the docs (or the--jsoncontract documented elsewhere in the CLI reference) would expect.Changes
src/poly/resources/handoff.py: omitsip_headersfrom the serialized YAML when empty instead of always writing it out, matching its documented optional statussrc/poly/cli_commands/review.py:poly review delete --jsonnow returns a JSON error instead of falling through to an interactive checkbox prompt when no gist ID is given, consistent with the "--jsonrequires explicit flags" pattern documented for other commandssrc/poly/tests/github_api_test.py: updated the one test that encoded the old (interactive-fallback) behavior to assert the new error-and-return behavior instead; the existing "gist ID +--json" success-path test was unaffectedTest strategy
poly <command>)Checklist
ruff check .andruff format --check .passpytestpassespolyCLI interface (or migration path documented)Screenshots / Logs
N/A