From 80b2222cd3e541d4265d91637aa8a9d2395edd0d Mon Sep 17 00:00:00 2001 From: andrewrice Date: Wed, 17 May 2017 12:31:54 -0700 Subject: [PATCH] Update summary of ArgumentSelectionDefectChecker to make it clearer that adding comments to names is a viable fix RELNOTES: Update summary of ArgumentSelectionDefectChecker ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=156339195 --- .../ArgumentSelectionDefectChecker.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/core/src/main/java/com/google/errorprone/bugpatterns/argumentselectiondefects/ArgumentSelectionDefectChecker.java b/core/src/main/java/com/google/errorprone/bugpatterns/argumentselectiondefects/ArgumentSelectionDefectChecker.java index aeca8a804c1..113f1833c39 100644 --- a/core/src/main/java/com/google/errorprone/bugpatterns/argumentselectiondefects/ArgumentSelectionDefectChecker.java +++ b/core/src/main/java/com/google/errorprone/bugpatterns/argumentselectiondefects/ArgumentSelectionDefectChecker.java @@ -54,13 +54,13 @@ */ @BugPattern( name = "ArgumentSelectionDefectChecker", - summary = "Arguments to this method call may be in the wrong order", + summary = "Arguments are in the wrong order or could be commented for clarity.", explanation = "If permuting the arguments of a method call means that the argument names are a better " + "match for the parameter names than the original ordering then this might indicate " + "that they have been accidentally swapped. There are also legitimate reasons for the " + "names not to match such as when rotating an image (swap width and height). In this " - + "case we would recommend annotating the names with a comment to make the deliberate " + + "case we suggest annotating the names with a comment to make the deliberate " + "swap clear to future readers of the code. Argument names annotated with a comment " + "containing the parameter name will not generate a warning.", category = JDK,