[Mlir-commits] [mlir] cba4e7e - [MLIR][Doc] Clarify the cf.asssert doc that this is a runtime assertion

[Mehdi Amini]

Author: Mehdi Amini
Date: 2023-10-18T08:57:22-07:00
New Revision: cba4e7e9e629b50c836ae8dda3ef60985e417180

URL: https://github.com/llvm/llvm-project/commit/cba4e7e9e629b50c836ae8dda3ef60985e417180
DIFF: https://github.com/llvm/llvm-project/commit/cba4e7e9e629b50c836ae8dda3ef60985e417180.diff

LOG: [MLIR][Doc] Clarify the cf.asssert doc that this is a runtime assertion

Added: 
    

Modified: 
    mlir/include/mlir/Dialect/ControlFlow/IR/ControlFlowOps.td

Removed: 
    


################################################################################
diff  --git a/mlir/include/mlir/Dialect/ControlFlow/IR/ControlFlowOps.td b/mlir/include/mlir/Dialect/ControlFlow/IR/ControlFlowOps.td
index b396b2c2c141307..f77b8cbbbc61d23 100644
--- a/mlir/include/mlir/Dialect/ControlFlow/IR/ControlFlowOps.td
+++ b/mlir/include/mlir/Dialect/ControlFlow/IR/ControlFlowOps.td
@@ -40,7 +40,8 @@ class CF_Op<string mnemonic, list<Trait> traits = []> :
 def AssertOp : CF_Op<"assert"> {
   let summary = "Assert operation with message attribute";
   let description = [{
-    Assert operation with single boolean operand and an error message attribute.
+    Assert operation at runtime with single boolean operand and an error
+    message attribute.
     If the argument is `true` this operation has no effect. Otherwise, the
     program execution will abort. The provided error message may be used by a
     runtime to propagate the error to the user.