Skip to content

Commit e91e73a

Browse files
authored
Fix some comment typos (#492)
1 parent a1c361d commit e91e73a

File tree

3 files changed

+21
-13
lines changed

3 files changed

+21
-13
lines changed

openapi/openapiv2.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9586,7 +9586,7 @@
95869586
"backlogCountHint": {
95879587
"type": "string",
95889588
"format": "int64",
9589-
"description": "A hint that there are more tasks already present in this task queue \npartition. Can be used to prioritize draining a sticky queue.\n\nSpecifically, the returned number is the number of tasks remaining in\nthe in-memory buffer for this partition, which is currently capped at\n1000. Because sticky queues only have one partition, this number is \nmore useful when draining them. Normal queues, typically having more than one \npartition, will return a number representing only some portion of the \noverall backlog. Subsequent RPCs may not hit the same partition as \nthis call."
9589+
"description": "A hint that there are more tasks already present in this task queue\npartition. Can be used to prioritize draining a sticky queue.\n\nSpecifically, the returned number is the number of tasks remaining in\nthe in-memory buffer for this partition, which is currently capped at\n1000. Because sticky queues only have one partition, this number is\nmore useful when draining them. Normal queues, typically having more than one\npartition, will return a number representing only some portion of the\noverall backlog. Subsequent RPCs may not hit the same partition as\nthis call."
95909590
},
95919591
"history": {
95929592
"$ref": "#/definitions/v1History",
@@ -10168,7 +10168,7 @@
1016810168
"properties": {
1016910169
"discardSpeculativeWorkflowTaskWithEvents": {
1017010170
"type": "boolean",
10171-
"title": "True if the SDK can handle speculative workflow task with command events.\nIf true, the server may chosse, at its discretion, to discard a speculative workflow task\neven if that speculative task included command events the SDK had not previouly processed"
10171+
"description": "True if the SDK can handle speculative workflow task with command events. If true, the\nserver may choose, at its discretion, to discard a speculative workflow task even if that\nspeculative task included command events the SDK had not previously processed.\n"
1017210172
}
1017310173
},
1017410174
"description": "SDK capability details."

openapi/openapiv3.yaml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7034,7 +7034,17 @@ components:
70347034
format: int32
70357035
backlogCountHint:
70367036
type: string
7037-
description: "A hint that there are more tasks already present in this task queue \n partition. Can be used to prioritize draining a sticky queue.\n\n Specifically, the returned number is the number of tasks remaining in\n the in-memory buffer for this partition, which is currently capped at\n 1000. Because sticky queues only have one partition, this number is \n more useful when draining them. Normal queues, typically having more than one \n partition, will return a number representing only some portion of the \n overall backlog. Subsequent RPCs may not hit the same partition as \n this call."
7037+
description: |-
7038+
A hint that there are more tasks already present in this task queue
7039+
partition. Can be used to prioritize draining a sticky queue.
7040+
7041+
Specifically, the returned number is the number of tasks remaining in
7042+
the in-memory buffer for this partition, which is currently capped at
7043+
1000. Because sticky queues only have one partition, this number is
7044+
more useful when draining them. Normal queues, typically having more than one
7045+
partition, will return a number representing only some portion of the
7046+
overall backlog. Subsequent RPCs may not hit the same partition as
7047+
this call.
70387048
history:
70397049
allOf:
70407050
- $ref: '#/components/schemas/History'

temporal/api/workflowservice/v1/request_response.proto

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -282,15 +282,15 @@ message PollWorkflowTaskQueueResponse {
282282
int64 started_event_id = 5;
283283
// Starting at 1, the number of attempts to complete this task by any worker.
284284
int32 attempt = 6;
285-
// A hint that there are more tasks already present in this task queue
285+
// A hint that there are more tasks already present in this task queue
286286
// partition. Can be used to prioritize draining a sticky queue.
287287
//
288288
// Specifically, the returned number is the number of tasks remaining in
289289
// the in-memory buffer for this partition, which is currently capped at
290-
// 1000. Because sticky queues only have one partition, this number is
291-
// more useful when draining them. Normal queues, typically having more than one
292-
// partition, will return a number representing only some portion of the
293-
// overall backlog. Subsequent RPCs may not hit the same partition as
290+
// 1000. Because sticky queues only have one partition, this number is
291+
// more useful when draining them. Normal queues, typically having more than one
292+
// partition, will return a number representing only some portion of the
293+
// overall backlog. Subsequent RPCs may not hit the same partition as
294294
// this call.
295295
int64 backlog_count_hint = 7;
296296
// The history for this workflow, which will either be complete or partial. Partial histories
@@ -358,9 +358,9 @@ message RespondWorkflowTaskCompletedRequest {
358358
Capabilities capabilities = 14;
359359
// SDK capability details.
360360
message Capabilities {
361-
// True if the SDK can handle speculative workflow task with command events.
362-
// If true, the server may chosse, at its discretion, to discard a speculative workflow task
363-
// even if that speculative task included command events the SDK had not previouly processed
361+
// True if the SDK can handle speculative workflow task with command events. If true, the
362+
// server may choose, at its discretion, to discard a speculative workflow task even if that
363+
// speculative task included command events the SDK had not previously processed.
364364
//
365365
// (-- api-linter: core::0140::prepositions=disabled
366366
// aip.dev/not-precedent: "with" used to describe the workflow task. --)
@@ -1814,5 +1814,3 @@ message ResetActivityByIdRequest {
18141814

18151815
message ResetActivityByIdResponse {
18161816
}
1817-
1818-

0 commit comments

Comments
 (0)