From 36c3d872721954aae60df42d484624d3805bfb18 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Fournier?= Date: Tue, 25 Aug 2020 14:38:59 +0200 Subject: [PATCH] Add md formatting --- .../src/main/resources/category/java/errorprone.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pmd-java/src/main/resources/category/java/errorprone.xml b/pmd-java/src/main/resources/category/java/errorprone.xml index bdc9cc92c7..94875fb765 100644 --- a/pmd-java/src/main/resources/category/java/errorprone.xml +++ b/pmd-java/src/main/resources/category/java/errorprone.xml @@ -3052,11 +3052,11 @@ StringBuilder sb4 = new StringBuilder("c"); class="net.sourceforge.pmd.lang.rule.XPathRule" externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_errorprone.html#suspiciousequalsmethodname"> -The method name and parameter number are suspiciously close to Object.equals, which can denote an -intention to override it. However, the method does not override Object.equals, but overloads it instead. -Overloading Object.equals method is confusing for other programmers, error-prone and hard to maintain, -especially when using inheritance, because @Override annotations used in subclasses can provide a false -sense of security. For more information on Object.equals method, see Effective Java, 3rd Edition, +The method name and parameter number are suspiciously close to `Object.equals`, which can denote an +intention to override it. However, the method does not override `Object.equals`, but overloads it instead. +Overloading `Object.equals` method is confusing for other programmers, error-prone and hard to maintain, +especially when using inheritance, because `@Override` annotations used in subclasses can provide a false +sense of security. For more information on `Object.equals` method, see Effective Java, 3rd Edition, Item 10: Obey the general contract when overriding equals. 2