Skip to content

Commit e7588e4

Browse files
committed
fix doc
1 parent d769f01 commit e7588e4

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

internal/workflow.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1614,11 +1614,11 @@ func ExecuteWithMinVersion() GetVersionOption {
16141614
// It is not allowed to update workflow code while there are workflows running as it is going to break
16151615
// determinism. The solution is to have both old code that is used to replay existing workflows
16161616
// as well as the new one that is used when it is executed for the first time.
1617-
// GetVersion returns maxSupported version
1618-
// (to return another version for a potential safe rollback, check documentation for ExecuteWithVersion and ExecuteWithMinVersion),
1619-
// when is executed for the first time. This version is recorded into the
1617+
// GetVersion returns maxSupported version when is executed for the first time. This version is recorded into the
16201618
// workflow history as a marker event. Even if maxSupported version is changed the version that was recorded is
16211619
// returned on replay. DefaultVersion constant contains version of code that wasn't versioned before.
1620+
// Check documentation for ExecuteWithVersion and ExecuteWithMinVersion to make your changes forward and backward compatible.
1621+
//
16221622
// For example initially workflow has the following code:
16231623
//
16241624
// err = workflow.ExecuteActivity(ctx, foo).Get(ctx, nil)

workflow/workflow.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -419,11 +419,11 @@ func ExecuteWithMinVersion() GetVersionOption {
419419
// It is not allowed to update workflow code while there are workflows running as it is going to break
420420
// determinism. The solution is to have both old code that is used to replay existing workflows
421421
// as well as the new one that is used when it is executed for the first time.
422-
// GetVersion returns maxSupported version
423-
// (to return another version for a potential safe rollback, check documentation for ExecuteWithVersion and ExecuteWithMinVersion),
424-
// when is executed for the first time. This version is recorded into the
422+
// GetVersion returns maxSupported version when is executed for the first time. This version is recorded into the
425423
// workflow history as a marker event. Even if maxSupported version is changed the version that was recorded is
426424
// returned on replay. DefaultVersion constant contains version of code that wasn't versioned before.
425+
// Check documentation for ExecuteWithVersion and ExecuteWithMinVersion to make your changes forward and backward compatible.
426+
//
427427
// For example initially workflow has the following code:
428428
//
429429
// err = workflow.ExecuteActivity(ctx, foo).Get(ctx, nil)

0 commit comments

Comments
 (0)