llvmorg-github-actions[bot] wrote:
<!--LLVM PR SUMMARY COMMENT--> @llvm/pr-subscribers-clang-tidy Author: Zeyi Xu (zeyi2) <details> <summary>Changes</summary> --- Full diff: https://github.com/llvm/llvm-project/pull/210576.diff 1 Files Affected: - (modified) clang-tools-extra/docs/clang-tidy/Contributing.rst (+1-18) ``````````diff diff --git a/clang-tools-extra/docs/clang-tidy/Contributing.rst b/clang-tools-extra/docs/clang-tidy/Contributing.rst index 65933061b49f1..d8278c3687bd4 100644 --- a/clang-tools-extra/docs/clang-tidy/Contributing.rst +++ b/clang-tools-extra/docs/clang-tidy/Contributing.rst @@ -466,24 +466,7 @@ generator and create HTML documentation files in the ``tools/clang/tools/extra/docs/html`` directory in your build tree. Make sure that your check is correctly shown in the release notes and the list of checks. Make sure that the formatting and structure of your check's -documentation look correct: there is no trailing whitespaces and lines are no -longer than 80 characters. - -To validate your files, please use ``doc8`` as described below. - -Clang-Tidy uses `doc8 <https://pypi.org/project/doc8/>`_ to check ``.rst`` -files for formatting consistency. You can install ``doc8`` with ``pip``: - -.. code-block:: console - - $ pip install doc8 - -To run ``doc8`` on the modified documentations: - -.. code-block:: console - - $ git diff --name-only HEAD -- clang-tools-extra/docs/clang-tidy/ | grep "\.rst$" | xargs -r doc8 - +documentation look correct and contain no trailing whitespace. Registering your Check ---------------------- `````````` </details> https://github.com/llvm/llvm-project/pull/210576 _______________________________________________ cfe-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
