fix comments and grammar (#1959)

Author: yuandrew

contrib/tools/workflowcheck/determinism/checker.go

@@ -448,7 +448,7 @@ func (p *PackageLookupCache) PackageNonDeterminisms(pkg *types.Package) PackageN
 	if pkg == nil {
 		return nil
 	}
-	// The import has to be done under lock too since it's not concurrency safe
+	// The import must also be done under lock because it is not concurrency-safe
 	p.packageNonDeterminismsLock.Lock()
 	defer p.packageNonDeterminismsLock.Unlock()
 	ret, exists := p.packageNonDeterminisms[pkg]

contrib/tools/workflowcheck/determinism/reason.go

@@ -127,7 +127,7 @@ func (r *ReasonFuncCall) String() string {
 
 func (r *ReasonFuncCall) PackageName() string {
 	pkgPrefixedName := r.FuncName
-	// If there is a ending paren it's a method, take the receiver as the name
+	// If there is an ending parenthesis, it's a method; take the receiver as the name
 	if endParen := strings.Index(r.FuncName, ")"); endParen >= 0 {
 		pkgPrefixedName = strings.TrimLeft(r.FuncName[:endParen], "(*")
 	}

internal/error.go

@@ -113,7 +113,7 @@ type (
 		//
 		// NOTE: This option is supported by Temporal Server >= v1.24.2 older version will ignore this value.
 		NextRetryDelay time.Duration
-		// Category of the error. Maps to logging/metrics behaviours.
+		// Category of the error. Maps to logging/metrics behaviors.
 		Category ApplicationErrorCategory
 	}
 
@@ -356,7 +356,7 @@ var (
 )
 
 // ApplicationErrorCategory sets the category of the error. The category of the error
-// maps to logging/metrics behaviours.
+// maps to logging/metrics behaviors.
 //
 // Exposed as: [go.temporal.io/sdk/temporal.ApplicationErrorCategory]
 type ApplicationErrorCategory int

internal/headers.go

@@ -40,7 +40,7 @@ type (
 
 	// ContextAware is an optional interface that can be implemented alongside
 	// DataConverter. This interface allows Temporal to pass Workflow/Activity
-	// contexts to the DataConverter so that it may tailor it's behaviour.
+	// contexts to the DataConverter so that it may tailor its behavior.
 	//
 	// Note that data converters may be called in non-context-aware situations to
 	// convert payloads that may not be customized per context. Data converter

internal/internal_flags.go

@@ -59,10 +59,10 @@ func (f sdkFlag) isValid() bool {
 // sdkFlags represents all the flags that are currently set in a workflow execution.
 type sdkFlags struct {
 	capabilities *workflowservice.GetSystemInfoResponse_Capabilities
-	// Flags that have been recieved from the server
+	// Flags that have been received from the server
 	currentFlags map[sdkFlag]bool
 	// Flags that have been set this WFT that have not been sent to the server.
-	// Keep track of them sepratly so we know what to send to the server.
+	// Keep track of them separately so we know what to send to the server.
 	newFlags map[sdkFlag]bool
 }
 
@@ -123,7 +123,7 @@ func (sf *sdkFlags) gatherNewSDKFlags() []sdkFlag {
 }
 
 // SetUnblockSelectorSignal toggles the flag to unblock the selector signal.
-// For test use only,
+// For test use only.
 func SetUnblockSelectorSignal(unblockSignal bool) {
 	unblockSelectorSignal = unblockSignal
 }

internal/internal_task_handlers.go

@@ -581,7 +581,7 @@ func (w *workflowExecutionContextImpl) Lock() {
 	w.mutex.Lock()
 }
 
-// Unlock cleans up after the provided error and it's own internal view of the
+// Unlock cleans up after the provided error and its own internal view of the
 // workflow error state by clearing itself and removing itself from cache as
 // needed. It is an error to call this function without having called the Lock
 // function first and the behavior is undefined. Regardless of the error
@@ -591,7 +591,7 @@ func (w *workflowExecutionContextImpl) Unlock(err error) {
 	if err != nil || w.err != nil || w.isWorkflowCompleted ||
 		(w.wth.cache.MaxWorkflowCacheSize() <= 0 && !w.hasPendingLocalActivityWork()) {
 		// TODO: in case of closed, it assumes the close command always succeed. need server side change to return
-		// error to indicate the close failure case. This should be rare case. For now, always remove the cache, and
+		// error to indicate the close failure case. This should be a rare case. For now, always remove the cache, and
 		// if the close command failed, the next command will have to rebuild the state.
 		if w.wth.cache.getWorkflowCache().Exist(w.workflowInfo.WorkflowExecution.RunID) {
 			w.wth.cache.removeWorkflowContext(w.workflowInfo.WorkflowExecution.RunID)

temporal/error.go

@@ -251,7 +251,7 @@ func NewHeartbeatTimeoutError(details ...interface{}) error {
 }
 
 // ApplicationErrorCategory sets the category of the error. The category of the error
-// maps to logging/metrics SDK behaviours, does not impact server-side logging/metrics.
+// maps to logging/metrics SDK behaviors and does not impact server-side logging/metrics.
 type ApplicationErrorCategory = internal.ApplicationErrorCategory
 
 const (

test/integration_test.go

@@ -4147,7 +4147,7 @@ func (ts *IntegrationTestSuite) testUpdateOrderingCancel(cancelWf bool) {
 		}()
 	}
 
-	// Server does not support admitted so we have to send the update in a seperate goroutine
+	// The server does not support admitted updates, so we send the update in a separate goroutine
 	time.Sleep(5 * time.Second)
 	// Now create a new worker on that same task queue to resume the work of the
 	// workflow

workflow/context.go

@@ -14,7 +14,7 @@ type Context = internal.Context
 
 // ContextAware is an optional interface that can be implemented alongside
 // DataConverter. This interface allows Temporal to pass Workflow/Activity
-// contexts to the DataConverter so that it may tailor it's behaviour.
+// contexts to the DataConverter so that it may tailor its behavior.
 //
 // Note that data converters may be called in non-context-aware situations to
 // convert payloads that may not be customized per context. Data converter

workflow/doc.go

@@ -103,7 +103,7 @@ deterministic and repeatable within an execution context.
 
 Coroutine related constructs:
 
-  - [workflow.Go] : This is a replacement for the the go statement
+  - [workflow.Go] : This is a replacement for the go statement
   - [workflow.Channel] : This is a replacement for the native chan type. Temporal
     provides support for both buffered and unbuffered channels
   - [workflow.Selector] : This is a replacement for the select statement
@@ -532,8 +532,8 @@ framework via [go.temporal.io/sdk/testsuite.WorkflowTestSuite]. Since every test
 our struct to hold an instance of the test environment. This will allow us to initialize the test environment in a
 setup method. For testing workflows we use a [go.temporal.io/sdk/testsuite.TestWorkflowEnvironment].
 
-We then implement a SetupTest method to setup a new test environment before each test. Doing so ensure that each test
-runs in it's own isolated sandbox. We also implement an AfterTest function where we assert that all mocks we setup were
+We then implement a SetupTest method to set up a new test environment before each test. Doing so ensures that each test
+runs in its own isolated sandbox. We also implement an AfterTest function where we assert that all mocks we set up were
 indeed called by invoking s.env.AssertExpectations(s.T()).
 
 Finally, we create a regular test function recognized by "go test" and pass the struct to suite.Run.