[Document] Potentially misleading inline comment for PollWorkflowTaskQueueResponse
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- grpc
- Domain
- api, documentation
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.
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.
- Dominant language
- Go
- Stars
- 133
- Forks
- 101
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 11
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.
More from temporalio/api
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 58/100
temporalio/api#750 ·
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
temporalio/api#427 · 1 comment ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 45/100
temporalio/api#421 ·
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
temporalio/api#400 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
temporalio/api#328 · 6 reactions ·
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Bob Shell support Openenhancement
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
santhosh-tekuri/jsonschema#276 ·