Skip to content

Commit 0c8c780

Browse files
committed
Code review suggestions
1 parent e39e8d2 commit 0c8c780

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

client/client.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@ type (
527527

528528
// SignalWorkflow sends a signals to a running workflow.
529529
// - workflow ID of the workflow.
530-
// - runID can be default(empty string). If empty string then it will pick the running execution of that workflow ID.
530+
// - runID can be default(empty string). If set to empty string, then it will pick the running execution of that workflow ID.
531531
// - signalName name to identify the signal.
532532
// The errors it can return:
533533
// - serviceerror.NotFound

internal/workflow.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,8 @@ type (
128128
// json.Unmarshal.
129129
ReceiveAsync(valuePtr interface{}) (ok bool)
130130

131-
// ReceiveAsyncWithMoreFlag is the same as ReceiveAsync but with an extra return value `more` that indicates
132-
// whether the channel contains more data. `more` is false when the channel is closed.
131+
// ReceiveAsyncWithMoreFlag is the same as ReceiveAsync but with an extra return value more that indicates
132+
// whether the channel contains more data. more is false when the channel is closed.
133133
//
134134
// Note, values should not be reused for extraction here because merging on top of existing values may result in
135135
// unexpected behavior similar to json.Unmarshal.
@@ -146,7 +146,7 @@ type (
146146
ReceiveChannel
147147
}
148148

149-
// Selector must be used by workflow code instead of native go `select`.
149+
// Selector must be used by workflow code instead of native go select.
150150
// Use workflow.NewSelector(ctx) to create a selector.
151151
Selector interface {
152152
// AddReceive registers a callback function to be called when a channel has a message to receive.
@@ -531,7 +531,7 @@ func NewSemaphore(ctx Context, n int64) Semaphore {
531531
return &semaphoreImpl{size: n}
532532
}
533533

534-
// Go creates a new coroutine in workflow code. It has similar semantics to native goroutines, but these must not be
534+
// Go creates a new coroutine in workflow code. It has similar semantics to native goroutines, which must not be
535535
// used in workflow code.
536536
func Go(ctx Context, f func(ctx Context)) {
537537
assertNotInReadOnlyState(ctx)
@@ -540,7 +540,7 @@ func Go(ctx Context, f func(ctx Context)) {
540540
}
541541

542542
// GoNamed creates a new coroutine in workflow code, with a given human-readable name. It has similar semantics to
543-
// native goroutines, but these must not be used in workflow code. Name appears in stack traces that are blocked on this
543+
// native goroutines, which must not be used in workflow code. name appears in stack traces that are blocked on this
544544
// Channel.
545545
func GoNamed(ctx Context, name string, f func(ctx Context)) {
546546
assertNotInReadOnlyState(ctx)

0 commit comments

Comments
 (0)