[all-commits] [llvm/llvm-project] 8727da: [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: 8727da4880d069d0feb0c4346b902dc917500083
      https://github.com/llvm/llvm-project/commit/8727da4880d069d0feb0c4346b902dc917500083
  Author: Zeyi Xu <mitchell.xu2 at gmail.com>
  Date:   2026-09-07 (Mon, 07 Sep 2026)

  Changed paths:
    A clang-tools-extra/docs/clang-tidy/checks/readability/ambiguous-smartptr-reset-call.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/ambiguous-smartptr-reset-call.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/avoid-return-with-void-value.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/avoid-return-with-void-value.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/avoid-unconditional-preprocessor-if.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/avoid-unconditional-preprocessor-if.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/braces-around-statements.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/braces-around-statements.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/const-return-type.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/const-return-type.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/container-contains.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/container-contains.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/duplicate-include.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/duplicate-include.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/else-after-return.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/else-after-return.rst
    A clang-tools-extra/docs/clang-tidy/checks/readability/enum-initial-value.md
    R clang-tools-extra/docs/clang-tidy/checks/readability/enum-initial-value.rst

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

Tracking issue: #201242

See the [migration guide] for more information.

[migration guide]:

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

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


  Commit: 76a090dfd9d81761087453de3ada2eb7ff2528f7
      https://github.com/llvm/llvm-project/commit/76a090dfd9d81761087453de3ada2eb7ff2528f7
  Author: Zeyi Xu <mitchell.xu2 at gmail.com>
  Date:   2026-09-07 (Mon, 07 Sep 2026)

  Changed paths:
    M clang-tools-extra/docs/clang-tidy/checks/readability/ambiguous-smartptr-reset-call.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/avoid-return-with-void-value.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/avoid-unconditional-preprocessor-if.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/braces-around-statements.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/const-return-type.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/container-contains.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/duplicate-include.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/else-after-return.md
    M clang-tools-extra/docs/clang-tidy/checks/readability/enum-initial-value.md

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

Tracking issue: #201242

See the [migration guide] for more information.

[migration guide]:

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

This is the first 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/abbc159932f1...76a090dfd9d8

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