[clang-tidy] Update documentation of readability-inconsistent-declaration-parameter-names

[piotrdz]

Summary

I forgot to update the documentation after the final rework of code that was committed.

[aaron.ballman]

With some minor grammatical changes, this LGTM!

~Aaron

docs/clang-tidy/checks/readability-inconsistent-declaration-parameter-name.rst

32

"to a single"

33

"that the function"

41

"In the case"

43

"seen in a translation"

[piotrdz]

Addressed issues found in review

[piotrdz]

@aaron.ballman: Thanks for the review. I uploaded an updated diff with fixes.

[aaron.ballman]

LGTM! Do you have commit privileges, or would you like me to commit on your behalf?

docs/clang-tidy/checks/readability-inconsistent-declaration-parameter-name.rst

44

Uncertain how much RST cares about this, but the previous file ended in a newline, so the current one likely should as well.

[piotrdz]

Ah, no, I don't - so far I have relied on other people to help with commits. I'd appreciate it if you could commit this for me. Thanks.

[aaron.ballman]

I have commit in r250194; thank you!

~Aaron

docs/clang-tidy/checks/readability-inconsistent-declaration-parameter-name.rst

    void foo(int a);
    void foo(int); // no warning
 
-If there are multiple declarations of same function, only one warning will be
-generated.
+To help with refactoring, in some cases FixIt hints are generated to align
+parameter names to a single naming convention. This works with the assumption
+that the function definition is the most up-to-date version, as it directly
+references parameter names in its body. Example:
+
+.. code:: c++
+
+   void foo(int a); // warning and FixIt hint (replace "a" to "b")
+   int foo(int b) { return b + 2; } // definition with use of "b"
+
+In the case of multiple redeclarations or function template specializations,
+a warning is issued for every redeclaration or specialization inconsistent with
+the definition or the first declaration seen in a translation unit.
 No newline at end of file