[all-commits] [llvm/llvm-project] 0d3abd: [mlir][Linalg] Fix formatting of generated docs ma...

Benjamin Maxwell via All-commits all-commits at lists.llvm.org
Wed Aug 16 08:09:39 PDT 2023

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 0d3abdc263546907864599e6f450501742212c79
  Author: Benjamin Maxwell <benjamin.maxwell at arm.com>
  Date:   2023-08-16 (Wed, 16 Aug 2023)

  Changed paths:
    M mlir/include/mlir/Dialect/Linalg/IR/LinalgNamedStructuredOps.yaml
    M mlir/test/mlir-linalg-ods-gen/test-linalg-ods-yaml-gen.yaml
    M mlir/tools/mlir-linalg-ods-gen/mlir-linalg-ods-yaml-gen.cpp

  Log Message:
  [mlir][Linalg] Fix formatting of generated docs markdown

This patch prevents `mlir-linalg-ods-yaml-gen` from adding extra
whitespace around the summary and description fields. This broke the
_italics_ of the summary as _ this _ is not recognised by markdown.
It also meant the first line of the description was in a code block
  as it was indented two spaces.

The separator between summary and description has also been updated to
two newlines. This was already followed and prevents line wrapping the
summary putting part of it in the description.

These issues can be currently seen at: https://mlir.llvm.org/docs/Dialects/Linalg/

Reviewed By: awarzynski

Differential Revision: https://reviews.llvm.org/D157853

More information about the All-commits mailing list