[Mlir-commits] [mlir] [MLIR] Improve Remark documentation to include mlir-opt usage (PR #159284)

[Mehdi Amini]

================
@@ -145,6 +154,19 @@ LogicalResult MyPass::runOnOperation() {
 }
 ```
 
+#### Example: Postpone remarks emitting
+
+`RemarkOpts` has `postpone` option. When it is set, the remark emission will be
+postponed until the end of the compilation.
----------------
joker-eph wrote:

We should document when/why this is useful, not just "what". It's not obvious to me why a remark author would want to use this and when?

https://github.com/llvm/llvm-project/pull/159284