[PATCH] D52984: [analyzer] Checker reviewer's checklist

Umann Kristóf via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Wed Nov 7 05:45:23 PST 2018


Szelethus added a comment.

In https://reviews.llvm.org/D52984#1269850, @NoQ wrote:

> - Warning and note messages should be clear and easy to understand, even if a bit long.
>   - Messages should start with a capital letter (unlike Clang warnings!) and should not end with `.`.
>   - Articles are usually omitted, eg. `Dereference of a null pointer` -> `Dereference of null pointer`.


I don't see this point in the list.

Coding standard related items should probably in a different list, alongside the out-of-alpha items.



================
Comment at: www/analyzer/checker_dev_manual.html:719
+<ul>
+<li>User facing documentation is important for adoption! Make sure the check list updated
+    at the homepage of the analyzer. Also ensure that the description is good quality in
----------------
Make sure the **checker** list **is** updated


================
Comment at: www/analyzer/checker_dev_manual.html:720
+<li>User facing documentation is important for adoption! Make sure the check list updated
+    at the homepage of the analyzer. Also ensure that the description is good quality in
+    <tt>Checkers.td</tt>.</li>
----------------
ensure the description is clear even to non-developers


https://reviews.llvm.org/D52984





More information about the cfe-commits mailing list