[all-commits] [llvm/llvm-project] d0b763: [mlir] [doc] fix typos in documentation (#120179)

[Timothy Hoffman via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: d0b7633d7ad566579bfb794f95cce9aef294c92b
      https://github.com/llvm/llvm-project/commit/d0b7633d7ad566579bfb794f95cce9aef294c92b
  Author: Timothy Hoffman <4001421+tim-hoffman at users.noreply.github.com>
  Date:   2024-12-20 (Fri, 20 Dec 2024)

  Changed paths:
    M mlir/docs/DefiningDialects/AttributesAndTypes.md
    M mlir/docs/PatternRewriter.md
    M mlir/docs/SymbolsAndSymbolTables.md
    M mlir/include/mlir/IR/DialectImplementation.h
    M mlir/include/mlir/IR/OpBase.td
    M mlir/include/mlir/Tools/mlir-opt/MlirOptMain.h

  Log Message:
  -----------
  [mlir] [doc] fix typos in documentation (#120179)

This PR fixes typos within documentation in various files.

Most changes are trivial. The one interesting change is the
documentation for `custom<X>` in `assemblyFormat` that used the wrong
return type. The return type from the `parseX` function should be
`ParseResult` rather than `LogicalResult`. The `ParseResult` type is
necessary due to tablegen generating code like the following within an
Op `parse()` function:
```
    auto odsResult = parseInferredArrayType(parser, elementsTypes, elementsOperands, resultRawTypes[0]);
    if (odsResult) return ::mlir::failure();
```
This will fail to compile if `parseInferredArrayType()` returns
`LogicalResult`. See also `parsePrettyLLVMType()` in LLVMTypes.h,
`parseSingleBlockRegion()` in IRDL.cpp, `parseDynamicIndexList()` in
ViewLikeInterface.cpp, etc.



To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications