This is an archive of the discontinued LLVM Phabricator instance.

[mlir][Linalg] Fix formatting of generated docs markdown
ClosedPublic

Authored by benmxwl-arm on Aug 14 2023, 3:15 AM.

Details

Summary

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/

Diff Detail

Event Timeline

benmxwl-arm created this revision.Aug 14 2023, 3:15 AM
Herald added a project: Restricted Project. · View Herald TranscriptAug 14 2023, 3:15 AM
benmxwl-arm requested review of this revision.Aug 14 2023, 3:15 AM
  • Allow line wrapping the summary
  • Rebase
benmxwl-arm edited the summary of this revision. (Show Details)Aug 15 2023, 2:59 AM
awarzynski accepted this revision.Aug 15 2023, 4:57 AM

I've been meaning to fix this for ages, thank you :) LGTM

This revision is now accepted and ready to land.Aug 15 2023, 4:57 AM