[llvm-branch-commits] [mlir] 87b4572 - [MLIR] [NFC] Update xla_lhlo WhileOp documentation

[Uday Bondhugula via llvm-branch-commits]

Author: Uday Bondhugula
Date: 2021-09-23T05:33:00+05:30
New Revision: 87b4572a6b574fba930770d0c8c96455d0340809

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

LOG: [MLIR] [NFC] Update xla_lhlo WhileOp documentation

Update xla_lhlo WhileOp documentation. NFC.

Added: 
    

Modified: 
    mlir/include/mlir/Dialect/LHLO/IR/LHLOOps.td

Removed: 
    


################################################################################
diff  --git a/mlir/include/mlir/Dialect/LHLO/IR/LHLOOps.td b/mlir/include/mlir/Dialect/LHLO/IR/LHLOOps.td
index 7f83425f138c..15c17ee3b85c 100644
--- a/mlir/include/mlir/Dialect/LHLO/IR/LHLOOps.td
+++ b/mlir/include/mlir/Dialect/LHLO/IR/LHLOOps.td
@@ -607,7 +607,11 @@ def LHLO_WhileOp
 
   string description = [{
     Returns the result of executing a body function until the cond body returns
-    true.
+    true. The `body` and `cond` regions are expected to have a single block
+    terminated with a `yield`. The operand (`init`), the result, the argument to
+    the body, the yield value from the body, and the argument to the conditional
+    are all a single tuple value of the same type. The yield value from the
+    conditional is always a boolean of type i1.
 
     See https://www.tensorflow.org/xla/operation_semantics#while.
   }];