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

[Zeyi Xu via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 8d4c923371a73b9f60bee93d91c1cc0c3b49b89e
      https://github.com/llvm/llvm-project/commit/8d4c923371a73b9f60bee93d91c1cc0c3b49b89e
  Author: Zeyi Xu <mitchell.xu2 at gmail.com>
  Date:   2026-09-09 (Wed, 09 Sep 2026)

  Changed paths:
    A clang-tools-extra/docs/clang-tidy/checks/readability/function-cognitive-complexity.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/function-cognitive-complexity.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/function-size.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/function-size.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/identifier-length.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/identifier-length.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/identifier-naming.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/identifier-naming.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/implicit-bool-conversion.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/implicit-bool-conversion.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/inconsistent-declaration-parameter-name.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/inconsistent-declaration-parameter-name.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/inconsistent-ifelse-braces.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/inconsistent-ifelse-braces.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/isolate-declaration.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/isolate-declaration.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/magic-numbers.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/magic-numbers.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/make-member-function-const.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/make-member-function-const.rst

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

Tracking issue: #201242

See the [migration guide] for more information.

[migration guide]:

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

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


  Commit: 30e244ed348addbc4611466404dd717d5906a1a7
      https://github.com/llvm/llvm-project/commit/30e244ed348addbc4611466404dd717d5906a1a7
  Author: Zeyi Xu <mitchell.xu2 at gmail.com>
  Date:   2026-09-09 (Wed, 09 Sep 2026)

  Changed paths:
    M clang-tools-extra/docs/clang-tidy/checks/readability/function-cognitive-complexity.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/function-size.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/identifier-length.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/identifier-naming.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/implicit-bool-conversion.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/inconsistent-declaration-parameter-name.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/inconsistent-ifelse-braces.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/isolate-declaration.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/magic-numbers.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/make-member-function-const.md

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

Tracking issue: #201242

See the [migration guide] for more information.

[migration guide]:

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

This is the second 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 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/b53c11f42061...30e244ed348a

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