Skip to content

Commit 83c70b7

Browse files
authored
Small docs addition for SignalWorkflow's "arg" argument (#1151)
Just had a user question today, since it wasn't explicitly documented. And "arg" is quite vague about the purpose, if you don't know what to expect.
1 parent 75941bf commit 83c70b7

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

client/client.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,7 @@ type (
136136
// - workflow ID of the workflow.
137137
// - runID can be default(empty string). if empty string then it will pick the running execution of that workflow ID.
138138
// - signalName name to identify the signal.
139+
// - arg is the data (or nil) to send with the signal, which can be read with the signal channel's Receive out-arg.
139140
// The errors it can return:
140141
// - EntityNotExistsError
141142
// - InternalServiceError
@@ -209,7 +210,7 @@ type (
209210
// The activity can fail with below errors ErrorWithDetails, TimeoutError, CanceledError.
210211
CompleteActivity(ctx context.Context, taskToken []byte, result interface{}, err error) error
211212

212-
// CompleteActivityById reports activity completed.
213+
// CompleteActivityByID reports activity completed.
213214
// Similar to CompleteActivity, but may save cadence user from keeping taskToken info.
214215
// activity Execute method can return activity.ErrResultPending to
215216
// indicate the activity is not completed when it's Execute method returns. In that case, this CompleteActivityById() method
@@ -317,7 +318,7 @@ type (
317318
// - workflowID is required.
318319
// - runID can be default(empty string). if empty string then it will pick the running execution of that workflow ID.
319320
// - queryType is the type of the query.
320-
// - args... are the optional query parameters.
321+
// - args... are the optional query parameters, which will be sent to your query handler function's args.
321322
// The errors it can return:
322323
// - BadRequestError
323324
// - InternalServiceError

0 commit comments

Comments
 (0)