[Document] Potentially misleading inline comment for PollWorkflowTaskQueueResponse
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 133
- Forks
- 101
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 11
Description
What are you really trying to do?
To clearly understand the scope of the workflow history returned in PollWorkflowTaskQueueResponse.
Describe the issue
At the moment, the inline comment is stated as below:
The history for this workflow, which will either be complete or partial. Partial histories
are sent to workers who have signaled that they are using a sticky queue when completing
a workflow task.
However, the term "complete" can be misleading as for long event history, this will only return the first page and rely on next_page_token for subsequent fetches.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open temporal/api/workflowservice/v1/request_response.proto and read the inline comment for PollWorkflowTaskQueueResponse.history. Clarify that the returned history may be paginated and that next_page_token is needed for subsequent pages; confirm the wording reflects the existing behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- grpc
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100