Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to mention Worker Key #1232

Open
tir38 opened this issue Dec 13, 2021 · 0 comments
Open

Update docs to mention Worker Key #1232

tir38 opened this issue Dec 13, 2021 · 0 comments

Comments

@tir38
Copy link

tir38 commented Dec 13, 2021

We talk about Worker identity in three places:

https://square.github.io/workflow/userguide/core-worker/#workers-define-their-own-equivalence

For these reasons, any time a workflow requests that a worker be run in sequential render passes, it is asked to compare itself with its last instance and determine if they are equivalent.

https://square.github.io/workflow/swift/api/WorkflowReactiveSwift/protocols/Worker/

https://square.github.io/workflow/kotlin/api/gfmCollector/workflow/com.squareup.workflow1/-worker/does-same-work-as/

Some or all of these documentations should also mention "Key" as a unique identifier when calling context.runningWorker

https://square.github.io/workflow/kotlin/api/gfmCollector/workflow/com.squareup.workflow1/running-worker/

@tir38 tir38 changed the title Update docs Update docs to mention Worker Key Dec 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants