-
Notifications
You must be signed in to change notification settings - Fork 13.4k
[clang-tidy][doc] align the title style in clang-tidy/index.rst #119938
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Uppercase each word in title and toctree _Originally posted by @nicovank in llvm#119842 (comment).
@llvm/pr-subscribers-clang-tidy @llvm/pr-subscribers-clang-tools-extra Author: Congcong Cai (HerrCai0907) ChangesUppercase each word in title and toctree Originally posted by @nicovank in #119842 (comment). Full diff: https://github.com/llvm/llvm-project/pull/119938.diff 1 Files Affected:
diff --git a/clang-tools-extra/docs/clang-tidy/index.rst b/clang-tools-extra/docs/clang-tidy/index.rst
index a4233d5d8e2694..26f11426c1dc4d 100644
--- a/clang-tools-extra/docs/clang-tidy/index.rst
+++ b/clang-tools-extra/docs/clang-tidy/index.rst
@@ -9,7 +9,7 @@ See also:
.. toctree::
:maxdepth: 1
- The list of clang-tidy checks <checks/list>
+ The List of Clang-Tidy Checks <checks/list>
Clang-tidy IDE/Editor Integrations <Integrations>
Getting Involved <Contributing>
External Clang-Tidy Examples <ExternalClang-TidyExamples>
@@ -21,7 +21,7 @@ static analysis. :program:`clang-tidy` is modular and provides a convenient
interface for writing new checks.
-Using clang-tidy
+Using Clang-Tidy
================
:program:`clang-tidy` is a `LibTooling`_-based tool, and it's easier to work
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ctrl+F -ing for lowercase clang-tidy
reveals a couple more places where it should maybe be updated: lines 331, 350 and 352 (:program:`clang-tidy`
?). It's very minor anyway.
IMO and ref to clang in clang's doc. clang-tidy should be treat as normal work so it can be uppercase or lowercase. In clang, all title in use uppercase word and in the content, clang still be lowercase. |
Co-authored-by: Nicolas van Kempen <[email protected]>
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/46/builds/9200 Here is the relevant piece of the build log for the reference
|
Uppercase each word in title and toctree
Originally posted by @nicovank in #119842 (comment).