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

Filling out Selector docs, and some adjacent ones I noticed #1131

Closed Groxx closed 2 years ago

Groxx commented 2 years ago

Recently I learned that Selector was basically undocumented, so I wanted to get around to improving that. And then @longquanzheng beat me to it! #685 is also an old PR that's related, though I didn't build off of that. But here's a bunch more text for people to read.

No doubt there are more docs to improve, but hopefully this is a step in the right direction.

coveralls commented 2 years ago

Pull Request Test Coverage Report for Build d8d9c0cd-4007-48dd-bfa4-8c34648867c2


Files with Coverage Reduction New Missed Lines %
internal/internal_task_pollers.go 2 80.67%
internal/common/convert.go 3 84.62%
<!-- Total: 5 -->
Totals Coverage Status
Change from base Build 03b9c258-3f56-4ec6-8208-23871bd8eaca: -0.03%
Covered Lines: 12166
Relevant Lines: 17010

💛 - Coveralls