From 2c90447e8203dd9c36629fcb96098d9cef15e7aa Mon Sep 17 00:00:00 2001 From: Bas Leijdekkers Date: Tue, 2 Apr 2024 15:23:45 +0200 Subject: [PATCH] [java] minor updates to inspection descriptions GitOrigin-RevId: 2009b2e0f8c7d1c268466fdc78431914bc6d3084 --- .../src/inspectionDescriptions/FillPermitsList.html | 4 +++- .../src/inspectionDescriptions/FoldExpressionIntoStream.html | 2 +- java/java-impl/src/inspectionDescriptions/Guava.html | 2 +- .../src/inspectionDescriptions/Java8CollectionRemoveIf.html | 2 +- .../src/inspectionDescriptions/MissingSerialAnnotation.html | 2 +- .../src/inspectionDescriptions/OptionalAssignedToNull.html | 2 +- .../ReplaceInefficientStreamCount.html | 5 ++--- .../SerialAnnotationUsedOnWrongMember.html | 2 +- 8 files changed, 11 insertions(+), 10 deletions(-) diff --git a/java/java-impl/src/inspectionDescriptions/FillPermitsList.html b/java/java-impl/src/inspectionDescriptions/FillPermitsList.html index b18108b4b8ce..18c5f2626d77 100644 --- a/java/java-impl/src/inspectionDescriptions/FillPermitsList.html +++ b/java/java-impl/src/inspectionDescriptions/FillPermitsList.html @@ -1,6 +1,8 @@ -Reports sealed classes whose permits clauses do not contain some of the subclasses from the same file. +Reports sealed classes without an explicit permits list. +Sealed classes that only have subclasses in the same file are not required to have an explicit permits list. +By default, this inspection does not highlight in the editor, but only provides a fix.

Example:


   sealed class A {}
diff --git a/java/java-impl/src/inspectionDescriptions/FoldExpressionIntoStream.html b/java/java-impl/src/inspectionDescriptions/FoldExpressionIntoStream.html
index 6fb68a05a3f7..5de3a11946d4 100644
--- a/java/java-impl/src/inspectionDescriptions/FoldExpressionIntoStream.html
+++ b/java/java-impl/src/inspectionDescriptions/FoldExpressionIntoStream.html
@@ -1,6 +1,6 @@
 
 
-Reports expressions with a repeating pattern which could be replaced with Stream API or String.join().
+Reports expressions with a repeating pattern that could be replaced with Stream API or a String.join() call.
 
Example:

 

   boolean allStartWith(String a, String b, String c, String d, String prefix) {
diff --git a/java/java-impl/src/inspectionDescriptions/Guava.html b/java/java-impl/src/inspectionDescriptions/Guava.html
index 9143831d7683..240e6202671e 100644
--- a/java/java-impl/src/inspectionDescriptions/Guava.html
+++ b/java/java-impl/src/inspectionDescriptions/Guava.html
@@ -12,7 +12,7 @@ Reports usages of Guava's functional primitives that can be migrated to standard
   List<String> results = List.of(1, 2, 3).stream().map(Object::toString).collect(Collectors.toList());
 

 

-The quick-fix may change the semantics. Some lazy-evaluated Guava's iterables can be transformed to eager-evaluated.
+The quick-fix may change the semantics. Some lazily evaluated Guava iterables can be transformed to eagerly evaluated.
 

 
 
diff --git a/java/java-impl/src/inspectionDescriptions/Java8CollectionRemoveIf.html b/java/java-impl/src/inspectionDescriptions/Java8CollectionRemoveIf.html
index 50ba9632165c..54e572b56aa3 100644
--- a/java/java-impl/src/inspectionDescriptions/Java8CollectionRemoveIf.html
+++ b/java/java-impl/src/inspectionDescriptions/Java8CollectionRemoveIf.html
@@ -1,6 +1,6 @@
 
 
-Reports loops which can be collapsed into a single Collection.removeIf call.
+Reports loops which can be collapsed into a single Collection.removeIf() call.
 
Example:

 

   for (Iterator<String> it = collection.iterator(); it.hasNext(); ) {
diff --git a/java/java-impl/src/inspectionDescriptions/MissingSerialAnnotation.html b/java/java-impl/src/inspectionDescriptions/MissingSerialAnnotation.html
index b067533f0fe0..034bcaf2edd0 100644
--- a/java/java-impl/src/inspectionDescriptions/MissingSerialAnnotation.html
+++ b/java/java-impl/src/inspectionDescriptions/MissingSerialAnnotation.html
@@ -39,7 +39,7 @@ class Main implements Serializable {
     }
   }
 

-
For more information about all possible cases, refer the documentation for java.io.Serial.

+
For more information about all possible cases, refer to the Javadoc of the java.io.Serial class.

 
 
New in 2020.3

 
diff --git a/java/java-impl/src/inspectionDescriptions/OptionalAssignedToNull.html b/java/java-impl/src/inspectionDescriptions/OptionalAssignedToNull.html
index ecab29a33f08..343e94affb34 100644
--- a/java/java-impl/src/inspectionDescriptions/OptionalAssignedToNull.html
+++ b/java/java-impl/src/inspectionDescriptions/OptionalAssignedToNull.html
@@ -1,6 +1,6 @@
 
 
-Reports null assigned to Optional variable or returned from method returning Optional.
+Reports null assigned to an Optional variable or returned from a method returning Optional.
 
It's recommended that you use Optional.empty() (or Optional.absent() for Guava) to denote an empty value.

 
Example:

 

diff --git a/java/java-impl/src/inspectionDescriptions/ReplaceInefficientStreamCount.html b/java/java-impl/src/inspectionDescriptions/ReplaceInefficientStreamCount.html
index e5536e17a47b..8077c2d9b1fc 100644
--- a/java/java-impl/src/inspectionDescriptions/ReplaceInefficientStreamCount.html
+++ b/java/java-impl/src/inspectionDescriptions/ReplaceInefficientStreamCount.html
@@ -1,9 +1,8 @@
 
 
-Reports Stream API call chains ending with the count() operation that
-could be optimized.
+Reports Stream API call chains ending with a count() operation, that are optimizable.
 

-  The following call chains are replaced by this inspection:
+  The following call chains can be replaced by this inspection:
 

 
    
   
  • Collection.stream().count() → Collection.size(). In Java 8 Collection.stream().count()
diff --git a/java/java-impl/src/inspectionDescriptions/SerialAnnotationUsedOnWrongMember.html b/java/java-impl/src/inspectionDescriptions/SerialAnnotationUsedOnWrongMember.html
index c756f94872b8..decea3cc1fbd 100644
--- a/java/java-impl/src/inspectionDescriptions/SerialAnnotationUsedOnWrongMember.html
+++ b/java/java-impl/src/inspectionDescriptions/SerialAnnotationUsedOnWrongMember.html
@@ -20,7 +20,7 @@ class Test implements Externalizable {
   }
 }
 

-
For information about all valid cases, refer the documentation for java.io.Serial.

+
For information about all valid cases, refer to the Javadoc of the java.io.Serial class.

 
 
New in 2020.3