@@ -896,21 +896,21 @@ data StmTxResult s a =
896
896
| StmTxAborted [SomeTVar s ] SomeException
897
897
898
898
899
- -- | A branch indicates an alternative statment available in the current context.
900
- -- For example, `OrElse` has two alternative statements, say "left" and "right".
901
- -- While executing the left statement, `OrElseStmA` branch indicates that the
902
- -- right branch is still available, in case, left statement fails.
899
+ -- | A branch indicates that an alternative statement is available in the current
900
+ -- context. For example, `OrElse` has two alternative statements, say "left"
901
+ -- and "right". While executing the left statement, `OrElseStmA` branch indicates
902
+ -- that the right branch is still available, in case the left statement fails.
903
903
data BranchStmA s a =
904
904
-- | `OrElse` statement with its 'right' alternative.
905
905
OrElseStmA (StmA s a )
906
- -- | `CatchStm` statment with 'catch' handler.
906
+ -- | `CatchStm` statement with the 'catch' handler.
907
907
| CatchStmA (SomeException -> StmA s a )
908
- -- | No op statment is not a part of the STM semantics. It simply
909
- -- indicates that there are no alternative statements left to be executed.
910
- -- For example, when running right alternative of the `OrElse` statement
911
- -- or when running the catch handler of a `CatchStm ` statement, there are
912
- -- alternative statements available. This case is represented by no-op
913
- -- branch.
908
+ -- | Unlike the other two branches, the no-op branch is not an explicit
909
+ -- part of the STM syntax. It simply indicates that there are no
910
+ -- alternative statements left to be executed. For example, when running
911
+ -- right alternative of the `OrElse ` statement or when running the catch
912
+ -- handler of a `CatchStm` statement, there are no alternative statements
913
+ -- available. This case is represented by the no-op branch.
914
914
| NoOpStmA
915
915
916
916
data StmStack s b a where
0 commit comments