[PATCH] D77456: [clangd] Parse `foo` in documentation comments and render as code.

Kadir Cetinkaya via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Sat Apr 4 03:08:45 PDT 2020


kadircet added a comment.

> But I'm wondering how good an idea this is for plaintext: "Returns 'foo' on failure" is better than "Returns foo on failure", right? (With backticks instead of single quotes, phab is eating my formatting)

ah sorry missed that one.

That's actually a good point, I didn't dwell on it too much because I don't think having backticks in plaintext is that useful. But thinking about it again some people might find it useful especially in long
documentations to figure out which parts of it to focus on. So this might be a regression for them, it would be nice to have some feedback mechanism for driving such decisions. So far it has been just
the reviewer and the author of the patch :D

So having a `raw` paragraph chunk(in addition to plaintext and inline code). might be a middle ground here.  Plaintext renderers will keep showing the documentation as it is written in the source code,
including backticks, whereas markdown renderers would display a more `rich` text. WDYT?


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D77456





More information about the cfe-commits mailing list