[all-commits] [llvm/llvm-project] 5e3f47: [clang-tidy][docs] Rename readability check docs t...

Zeyi Xu via All-commits all-commits at lists.llvm.org
Sat Oct 3 06:34:17 PDT 2026


  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 5e3f47931ec57e7d215c7120b0f83938443e5ec1
      https://github.com/llvm/llvm-project/commit/5e3f47931ec57e7d215c7120b0f83938443e5ec1
  Author: Zeyi Xu <zeyi2 at nekoarch.cc>
  Date:   2026-10-03 (Sat, 03 Oct 2026)

  Changed paths:
    A clang-tools-extra/docs/clang-tidy/checks/readability/static-accessed-through-instance.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/static-accessed-through-instance.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/string-compare.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/string-compare.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/suspicious-call-argument.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/suspicious-call-argument.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/trailing-comma.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/trailing-comma.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/trivial-switch.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/trivial-switch.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/uniqueptr-delete-release.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/uniqueptr-delete-release.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/uppercase-literal-suffix.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/uppercase-literal-suffix.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/use-anyofallof.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/use-anyofallof.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/use-concise-preprocessor-directives.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/use-concise-preprocessor-directives.rst

  Log Message:
  -----------
  [clang-tidy][docs] Rename readability check docs to Markdown [5/5] (#222032)

Tracking issue: #201242

See the [migration guide] for more information.

[migration guide]:

https://llvm.org/docs/SphinxQuickstartTemplate.html#markdown-migration-guidelines

This is the fifth part of the mechanical rename of the check
documentations in readability module.
The rewrite is provided by the next PR in this stack.


  Commit: f38c56a690c26077ac35d3d43b4026a7dfa5a2b9
      https://github.com/llvm/llvm-project/commit/f38c56a690c26077ac35d3d43b4026a7dfa5a2b9
  Author: Zeyi Xu <zeyi2 at nekoarch.cc>
  Date:   2026-10-03 (Sat, 03 Oct 2026)

  Changed paths:
    M clang-tools-extra/docs/clang-tidy/checks/readability/static-accessed-through-instance.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/string-compare.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/suspicious-call-argument.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/trailing-comma.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/trivial-switch.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/uniqueptr-delete-release.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/uppercase-literal-suffix.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/use-anyofallof.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/use-concise-preprocessor-directives.md

  Log Message:
  -----------
  [clang-tidy][docs] Rewrite readability check docs to Markdown [5/5] (#222033)

Tracking issue: #201242

See the [migration guide] for more information.

[migration guide]:

https://llvm.org/docs/SphinxQuickstartTemplate.html#markdown-migration-guidelines

This is the fifth part of rewriting check documentations in readability
module from reST to MyST Markdown.

AI Usage: This was prepared with rnk's fork of rst2myst and
GPT5.6-assisted (both Codex and AmpCode) cleanup.
I manually verified that the documentation renders as expected.

Preview site:
https://broken.life/llvm-staging/readability-markdown-port/index.html

---------

Co-authored-by: EugeneZelenko <eugene.zelenko at gmail.com>


Compare: https://github.com/llvm/llvm-project/compare/1f1a5b38374a...f38c56a690c2

To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications


More information about the All-commits mailing list