Document that non-IR units are passed by non-const reference instead of pointer in...
authorMehdi Amini <aminim@google.com>
Sat, 31 Aug 2019 22:17:42 +0000 (15:17 -0700)
committerA. Unique TensorFlower <gardener@tensorflow.org>
Sat, 31 Aug 2019 22:18:11 +0000 (15:18 -0700)
PiperOrigin-RevId: 266583029

mlir/g3doc/DeveloperGuide.md

index af04d7c4db7e3892a13a70bdc4496f6beeec1286..18be0786edcc26d897aa1d8c40e245a6626845c1 100644 (file)
@@ -6,10 +6,13 @@ methods).
 
 ## Style guide
 
-MLIR follows the [LLVM style](https://llvm.org/docs/CodingStandards.html) guide
-except:
+MLIR follows the [LLVM style](https://llvm.org/docs/CodingStandards.html) guide.
+We also adhere to the following, that deviates from, or isn't specified in the
+LLVM style guide:
 
 *   Adopts [camelBack](https://llvm.org/docs/Proposals/VariableNames.html);
+*   Except for IR units (Region, Block, and Operation), non-nullable output
+    argument are passed by non-const reference in general.
 
 ## Pass name and other command line options