[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation

[Nathan James via Phabricator via cfe-commits]

njames93 added inline comments.


================
Comment at: clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp:34
 
+static StringRef TrimFirstChar(StringRef x) { return x.substr(1); }
+
----------------
This seems a bit of a needless change,  if you want to remove the newline, just in date the raw string literal and remove the empty line


================
Comment at: clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp:53
+                            - key:   check-a.SomeOption
+                              value: value-a
+                            - key:   check-b.OtherOption
----------------
Can this be changed to match the previous format defined below 


================
Comment at: clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp:82
     CheckOptions:
-      some-check.SomeOption: 'some value'
+      - key:    some-check.SomeOption
+        value: 'some value'
----------------
This change can be reverted.


================
Comment at: clang-tools-extra/docs/clang-tidy/index.rst:261
+                            CheckOptions:
+                              - key:   check-a.SomeOption
+                                value: value-a
----------------
Again as before 


================
Comment at: clang-tools-extra/docs/clang-tidy/index.rst:292
+        - key:    some-check.SomeOption
+          value: 'some value'
       ...
----------------
Ditto


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D141144