Closed dandavison closed 2 months ago
I'd like to see the introduction to this page stick slightly closer to the other pages in our SDK docs as right now I think it contrasts too much. Otherwise, though, I like the emphasis on implementation details that increases toward the end of the page, I like what you're doing, and I think this is pretty close to being able to be merged. I left a few more comments, but I don't think this needs another round of feedback from me. Will let others finish weighing in.
Thanks for reviewing @axfelix.
I'd like to see the introduction to this page stick slightly closer to the other pages in our SDK docs as right now I think it contrasts too much.
I agree; I noticed this morning that the intro needed a bit more. Sorry it's been a bit of an evolving target during review due to our product launch aims.
@drewhoskins-temporal Is this ready to transition from SDK-1486 to EDU-671?
@drewhoskins-temporal Is this ready to transition from SDK-1486 to EDU-671?
Not quite -- I'll let you know when I've addressed everything remaining that I know of from my side.
Is this ready to transition from SDK-1486 to EDU-671?
Yes, over to docs team!
Erica's changes are merged into this one; this PR is now just waiting for an approval from docs team.
Thanks @axfelix and @fairlydurable.
I've added two final commits for @fairlydurable to review:
changing a code snippet only to address an uresolved review comment above: https://github.com/temporalio/documentation/pull/2976/commits/2820990b7ebd45ccdb5b72dfe70349c286d0c655
Adding a line documenting workflow.current_update_info
which should be included but was not: https://github.com/temporalio/documentation/commit/6446f01d78293aa42aa3be6766b8bc752ee1c11b
I'll obviously let you know if I think of any more omissions, but other than that over to you for merge.
[rendered]
This is a new version of the message-passing documentation for Python. It follows on from the new top-level section on https://docs.temporal.io/encyclopedia/workflow-message-passing that @drewhoskins-temporal recently wrote. The significant changes here are:
There is now a code sample at the top of the page that will immediately give many visitors to the page what they're looking for: it is minimal, but it shows how to define Query, Signal, and Update handlers, and an Update validator, and has one-line comments introducing the concepts.
Following the style taken in https://docs.temporal.io/encyclopedia/workflow-message-passing, the document recognizes that many aspects of Signal and Update handling can be covered together. This avoids a lot of repetition.
In particular, a new section named
Message handler patterns
gives Python-specific discussion and examples of the content outlined in encyclopedia/workflow-message-passing.Similarly, there was no need to discuss dynamic handlers separately for Signal, Query, and Update since the signatures are the same.
The structure of the document is (I'll keep this up-to-date it it changes)
TODO:
get_update_info()