Add comment for Await (#973)

meiliang86 · web-flow · commit ecb64cf088fe · 2020-05-15T16:29:55.000-07:00
diff --git a/workflow/deterministic_wrappers.go b/workflow/deterministic_wrappers.go
@@ -49,7 +49,8 @@ type (
 	WaitGroup = internal.WaitGroup
 )
 
-// Blocks the calling thread until condition() returns true
+// Blocks the calling thread until condition() returns true.
+// Do not mutate values or trigger side effects inside condition.
 // Returns CanceledError if the ctx is canceled.
 // The following code is going to block until the captured count
 // variable is set to 5.

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,8 @@ type (`
`49`	`49`	`WaitGroup = internal.WaitGroup`
`50`	`50`	`)`
`51`	`51`
`52`		`-// Blocks the calling thread until condition() returns true`
	`52`	`+// Blocks the calling thread until condition() returns true.`
	`53`	`+// Do not mutate values or trigger side effects inside condition.`
`53`	`54`	`// Returns CanceledError if the ctx is canceled.`
`54`	`55`	`// The following code is going to block until the captured count`
`55`	`56`	`// variable is set to 5.`