Skip to content

Commit d8d507c

Browse files
committed
[mlir] NFC: Clarify documentation on InferShapedTypeOpInterface::inferReturnTypeComponents
This patch copies a sentence from the documentation of `InferTypeOpInterface::inferReturnTypes()` to `InferShapedTypeOpInterface::inferReturnTypeComponents()`, clarifying that the method expects valid (verified) input arguments.
1 parent 5259fae commit d8d507c

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

mlir/include/mlir/Interfaces/InferTypeOpInterface.td

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,9 @@ def InferShapedTypeOpInterface : OpInterface<"InferShapedTypeOpInterface"> {
142142
Unknown (e.g., unranked) shape and nullptrs for element type and attribute
143143
may be returned by this function while returning success. E.g., partial
144144
population of components is not error condition.
145+
146+
Be aware that this method is supposed to be called with valid arguments,
147+
e.g., operands are verified, or it may result in an undefined behavior.
145148
}],
146149
/*retTy=*/"::mlir::LogicalResult",
147150
/*methodName=*/"inferReturnTypeComponents",

0 commit comments

Comments
 (0)