[Mlir-commits] [mlir] 50927f3 - Reword the documentation for the `mlirTranslateMain` API (NFC)

[Mehdi Amini]

Author: Mehdi Amini
Date: 2020-08-23T04:35:58Z
New Revision: 50927f3191f908142201ccc50962537bf9d96bda

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

LOG: Reword the documentation for the `mlirTranslateMain` API (NFC)

Address post-commit review in https://reviews.llvm.org/D86408

Added: 
    

Modified: 
    mlir/include/mlir/Translation.h

Removed: 
    


################################################################################
diff  --git a/mlir/include/mlir/Translation.h b/mlir/include/mlir/Translation.h
index ab9dad8b6d91..79220cc0d447 100644
--- a/mlir/include/mlir/Translation.h
+++ b/mlir/include/mlir/Translation.h
@@ -95,8 +95,11 @@ struct TranslationParser : public llvm::cl::parser<const TranslateFunction *> {
                        size_t globalWidth) const override;
 };
 
-/// Implementation for tools like `mlir-translate`. ToolName is used for the
-/// header displayed by `--help`.
+/// Translate to/from an MLIR module from/to an external representation (e.g.
+/// LLVM IR, SPIRV binary, ...). This is the entry point for the implementation
+/// of tools like `mlir-translate`. The translation to perform is parsed from
+/// the command line. The `toolName` argument is used for the header displayed
+/// by `--help`.
 LogicalResult mlirTranslateMain(int argc, char **argv,
                                 llvm::StringRef toolName);