This is an archive of the discontinued LLVM Phabricator instance.

[Documentation] Remove duplicated checks groups descriptions form clang-tidy/index.rst
ClosedPublic

Authored by Eugene.Zelenko on Aug 16 2016, 6:01 PM.

Diff Detail

Repository
rL LLVM

Event Timeline

Eugene.Zelenko retitled this revision from to [Documentation] Remove duplicated checks groups descriptions form clang-tidy/index.rst.
Eugene.Zelenko updated this object.
Eugene.Zelenko added a reviewer: alexfh.
Eugene.Zelenko set the repository for this revision to rL LLVM.
Eugene.Zelenko added a subscriber: cfe-commits.
alexfh requested changes to this revision.Aug 17 2016, 2:59 AM
alexfh edited edge metadata.
alexfh added inline comments.
docs/clang-tidy/index.rst
344 ↗(On Diff #68295)

These links point to the code, so they are still somewhat useful. We could leave a link to the clang-tidy directory (http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/) and explain that most subdirectories there correspond to check modules and the descriptions of modules can be found <link to the relevant section of this documentation>.

This revision now requires changes to proceed.Aug 17 2016, 2:59 AM
Eugene.Zelenko added a reviewer: aaron.ballman.

Rephrase text and add link to Clang-tidy directory. Will be good idea is native English speaker will look on this change.

alexfh requested changes to this revision.Aug 17 2016, 3:26 PM
alexfh edited edge metadata.
alexfh added inline comments.
docs/clang-tidy/index.rst
343 ↗(On Diff #68390)

are located in subdirectories of .... and contain checks targeting a certain aspect of code quality (performance, readability, etc.), certain coding style or standard (Google, LLVM, CERT, etc.) or a widely used API (e.g. MPI).

344 ↗(On Diff #68390)

Could you linkify above?

345 ↗(On Diff #68390)

The "If the check verifies..." sentence is now somewhat tautological, just remove it.

This revision now requires changes to proceed.Aug 17 2016, 3:26 PM
Eugene.Zelenko edited edge metadata.

Address Alexander's comments.

Eugene.Zelenko marked 3 inline comments as done.Aug 17 2016, 4:12 PM
Eugene.Zelenko marked an inline comment as done.Aug 17 2016, 4:12 PM
alexfh accepted this revision.Aug 17 2016, 4:25 PM
alexfh edited edge metadata.

LG. Thanks!

This revision is now accepted and ready to land.Aug 17 2016, 4:25 PM
This revision was automatically updated to reflect the committed changes.