[PATCH] D76735: [mlir][SPIRV] Update dialect/op documentation to be consistent with the rest of the dialects

[River Riddle via Phabricator via llvm-commits]

rriddle added a comment.

In D76735#1944631 <https://reviews.llvm.org/D76735#1944631>, @antiagainst wrote:

> The first part of description (before `### Custom assembly form`) is automatically populated from the SPIR-V spec by the gen_spirv_dialect.py tool.  The part after `### Custom assembly form` is manually added. So `### Custom assembly form` is the anchor at the moment to split. To remove it means we need rethink how the documentation is done. (The `Example ... mlir` part is fine as Mahesh pointed out.) Can I ask what do we want to achieve here? Will you automatically generate the custom assembly form's doc some way?


The overall goal is to bring some uniformity to the dialect documentation, and clean it up. The assembly form weirdness comes from the fact that we already generate a section for the syntax when the operation uses the `assemblyFormat` field, which leads to some redundancy: e.g. https://mlir.llvm.org/docs/Dialects/SPIRVDialect/#spv_address_of-spirvaddressofop


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D76735/new/

https://reviews.llvm.org/D76735