Skip to content

Commit

Permalink
Update WorkflowRun.Get Doc String (#1346)
Browse files Browse the repository at this point in the history
* Update internal_workflow_client.go

Doc string improvement

* Update internal_workflow_client.go

Suggested change

* Formatting
  • Loading branch information
bplunkett-stripe authored Jan 14, 2024
1 parent 5ca9a4d commit fac7f7f
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions internal/internal_workflow_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,10 @@ type (
GetRunID() string

// Get will fill the workflow execution result to valuePtr, if workflow
// execution is a success, or return corresponding error. This is a blocking
// API.
// execution is a success, or return corresponding error. If valuePtr is
// nil, valuePtr will be ignored and only the corresponding error of the
// workflow will be returned (nil on workflow execution success).
// This is a blocking API.
//
// This call will follow execution runs to the latest result for this run
// instead of strictly returning this run's result. This means that if the
Expand All @@ -138,8 +140,10 @@ type (
Get(ctx context.Context, valuePtr interface{}) error

// GetWithOptions will fill the workflow execution result to valuePtr, if
// workflow execution is a success, or return corresponding error. This is a
// blocking API.
// workflow execution is a success, or return corresponding error. If
// valuePtr is nil, valuePtr will be ignored and only the corresponding
// error of the workflow will be returned (nil on workflow execution success).
// This is a blocking API.
//
// Note, values should not be reused for extraction here because merging on
// top of existing values may result in unexpected behavior similar to
Expand Down

0 comments on commit fac7f7f

Please sign in to comment.