[PATCH] D138446: [clang-format][docs] Add ability to link to specific config options

Emilia Dreamer via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Mon Nov 28 09:11:22 PST 2022


rymiel added a comment.

Maybe the docs need somewhat of a fresh coat of paint.
As a clang-format user it's odd to find the options listed as "ConfigName (`EnumName`)" but when listing the actual options it's "`EnumOption` (In configuration: `ConfigOption`)".
At the very least, the order of the latter should be swapped around, but I'm unsure exactly how often people who land on that page need to see the names of the options as they are in `clang/lib/Format` (surely most people visiting that page are using `clang-format` as a CLI tool, but maybe I'm biased on this). I wouldn't want to get rid of them, but they certainly should be de-emphasized.

Simply moving the format badge (along with the enum name) to its next line following the option name as a heading would allow getting rid of the hacks introduced in this diff.

Better yet, I should just try it out and show how it would actually look in HTML instead of describing something purely visual...


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D138446



More information about the cfe-commits mailing list