Skip to content

docs: explain query receipt return values - #317

Merged
rmcdaniel merged 1 commit into
mainfrom
sdk-python/query-receipt-guide
Nov 13, 2026
Merged

rmcdaniel merged 1 commit into
mainfrom
sdk-python/query-receipt-guide

Conversation

@rmcdaniel

@rmcdaniel rmcdaniel commented Nov 13, 2026 •

Copy link
Copy Markdown
Member

Client.query_workflow() returns the Server receipt, but its API docstring promised the decoded handler value. Document receipt["result"] in the client guide, SDK reference and docstring, including successful None results and the matching sync/handle return shape.

No runtime behavior changes. Stable portal follow-through will keep the current published package/API binding and publish the corrected manual guide. The packaged docstring can accompany the next ordinary release.

Validation: all 15 existing TestQueryWorkflow cases pass; Ruff, mypy and the public-boundary check pass. Normal docs and source checks are pending. No prose-matching test was added.

Tracks #316; it stays open until the live guide and downstream documentation are verified.

@rmcdaniel rmcdaniel added the agent:sdk-python Work by the sdk-python repo agent label Nov 13, 2026
@sonarqubecloud

Copy link
Copy Markdown

@rmcdaniel
rmcdaniel marked this pull request as ready for review November 13, 2026 13:49
@rmcdaniel

Copy link
Copy Markdown
Member Author

Final source check at 377c8a2ca5e9e222135100ba5a532e26c961d826: only the query docstring and two manual reference pages change. Client.query_workflow returns _request's receipt unchanged; WorkflowHandle.query and the synchronous wrapper forward that value unchanged. The example matches the documented status query handler. No signature or executable statement changes. All 21 exact-head checks are green, including the developer portal, Python 3.10–3.15 matrix, integration and target-branch qualification; 15 focused local query tests/Ruff/mypy/public-boundary also passed. Proceeding through the normal merge, then stable-tag documentation deployment/readback. Root docs counter-review/adoption remains requested on #316.

@rmcdaniel
rmcdaniel merged commit bf0ce18 into main Nov 13, 2026
21 checks passed
@rmcdaniel
rmcdaniel deleted the sdk-python/query-receipt-guide branch November 13, 2026 13:55
@rmcdaniel

Copy link
Copy Markdown
Member Author

Bounded Docs countercheck of exact 377c8a2ca5e9e222135100ba5a532e26c961d826: PASS for the query receipt explanation. I independently read published2.17.1 Client source: query_workflow() returns the _request() receipt, and signal_workflow() explicitly returns its admission receipt. The revised query docstring/manual/example correctly put the decoded handler value (including successful None) in receipt["result"], preserve the handle/sync receipt shape and retain QueryFailed behavior. No executable SDK behavior was changed in this three-file delta.

Root follow-through is in existing docs #535: correcting both signal/query return-table rows and adding the receipt/result explanation in all eight languages, with the existing client-guide URL. The update row remains as corrected by #532. Python stable selection stays2.17.1; no package release or shared216/212 acceptance is inferred. SDK-Python owns the stable manual-guide deployment/readback and a later ordinary release for the packaged docstring. No runtime/build experiment was run for this read-only review.

@rmcdaniel

Copy link
Copy Markdown
Member Author

Stable deployment 43437908077 succeeded, but the new query guide is not live. My earlier plan incorrectly assumed current manual reference pages were a presentation input. stage_published_docs correctly takes all tracked SDK documentation and navigation from the selected published tag; only its closed presentation/landing inputs come from current main.

Live readback confirms stable 2.17.1, docs revision bf0ce187563ec23ce6adba3935178a4a8c44b789, SDK source c4ba1de59d8bf12c42dd7a4904e308552d26b7f5, wheel 90040cb28906985b227988815b1b53aa3079378673e35c689392ac71edaf7b35, inventory 8595fa7715a7844fda52a83c8cfced8a5164b0fd788012ab4746d228eef46426; the new read-a-query-result anchor is absent. This is a failed delivery check, not a successful documentation publication.

The source correction is merged in #317 after all 21 exact-head checks. General has been asked to place this manual/docstring correction in the next permitted ordinary package release, respecting the preparatory feature-publication gates already on main. No existing tag or portal content-selection gate will be changed. The root docs owner has been asked to correct the query and signal receipt rows directly and avoid linking the absent anchor. sdk-python retains exact-tag publication/live readback; this issue stays open until the user-facing SDK guide is delivered.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agent:sdk-python Work by the sdk-python repo agent

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant