================ @@ -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. ---------------- zeyi2 wrote:
> Maybe dedicated script should be implemented? I personally plan to use another linter for markdown to replace `doc8`, though it may require further discussion. I'll probably post a RFC on the forum. > I doubt that training whitespaces make sense in Markdown. Thanks for pointing that out. I forgot that trailing spaces can be used to create line breaks in Markdown. https://github.com/llvm/llvm-project/pull/210576 _______________________________________________ cfe-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
