uber-go / cadence-client

Framework for authoring workflows and activities running on top of the Cadence orchestration engine.
https://cadenceworkflow.io
MIT License
345 stars 131 forks source link

New docs section for canceled-context in workflows, other minor cleanups #1134

Closed Groxx closed 2 years ago

Groxx commented 2 years ago

Canceled-context documentation is currently strewn about in individual function documentation, though it's a fairly important concept that needs to be understood.

In particular, users sometimes are under the impression that "all things which accept a context will error", which can lead to nasty surprises like selector.Select(ctx)'s blocking behavior (causing a deadlocked workflow). Selector's docs have been improved in #1131, and this will hopefully make its behavior easier to learn before it is needed.

And, since I noticed some small other things while writing this chunk of docs, I've rolled those changes into here as well.

coveralls commented 2 years ago

Pull Request Test Coverage Report for Build fcc0307a-17f1-4226-a3a7-ff6129226ebd


Totals Coverage Status
Change from base Build 6f8d6cac-3789-4a94-b2a6-81a36ff95f17: 0.02%
Covered Lines: 12234
Relevant Lines: 19330

💛 - Coveralls