[GitHub] [groovy] sonatype-lift[bot] commented on a diff in pull request #1803: Polish org.codehaus.groovy.runtime package documentation

Tue, 18 Oct 2022 05:48:25 -0700 


sonatype-lift[bot] commented on code in PR #1803:
URL: https://github.com/apache/groovy/pull/1803#discussion_r998163212


##########
src/main/java/org/codehaus/groovy/runtime/metaclass/DefaultMetaClassInfo.java:
##########
@@ -104,21 +104,21 @@ public static void setOrigChar(boolean v) {
     //                  short
     //---------------------------------------------
 
-    // if original short meta class
+    // if original short metaclass
     private static boolean origShort = true;
     // if origShort and withoutCustomHandle
     private static boolean origShortRes = true;
 
     /**
-     * @return  true if no meta class creation handle is set and if
-     *          the original short meta class is used.
+     * @return  true if no metaclass creation handle is set and if

Review Comment:
   
*[MissingSummary](https://google.github.io/styleguide/javaguide.html#s7.2-summary-fragment):*
  A summary fragment is required; consider using the value of the @return block 
as a summary fragment instead.
   
   ---
   
   
   ```suggestion
        *Returns true if no metaclass creation handle is set and if
   ```
   
   
   
   ---
   
   <details><summary><b>ℹī¸ Learn about @sonatype-lift commands</b></summary>
   
   You can reply with the following commands. For example, reply with 
***@sonatype-lift ignoreall*** to leave out all findings.
   | **Command** | **Usage** |
   | ------------- | ------------- |
   | `@sonatype-lift ignore` | Leave out the above finding from this PR |
   | `@sonatype-lift ignoreall` | Leave out all the existing findings from this 
PR |
   | `@sonatype-lift exclude <file\|issue\|path\|tool>` | Exclude specified 
`file\|issue\|path\|tool` from Lift findings by updating your config.toml file |
   
   **Note:** When talking to LiftBot, you need to **refresh** the page to see 
its response.
   <sub>[Click here](https://github.com/apps/sonatype-lift/installations/new) 
to add LiftBot to another repo.</sub></details>
   
   
   
   ---
   
   Was this a good recommendation?
   [ [🙁 Not 
relevant](https://www.sonatype.com/lift-comment-rating?comment=346020682&lift_comment_rating=1)
 ] - [ [😕 Won't 
fix](https://www.sonatype.com/lift-comment-rating?comment=346020682&lift_comment_rating=2)
 ] - [ [😑 Not critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346020682&lift_comment_rating=3)
 ] - [ [🙂 Critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346020682&lift_comment_rating=4)
 ] - [ [😊 Critical, fixing 
now](https://www.sonatype.com/lift-comment-rating?comment=346020682&lift_comment_rating=5)
 ]



##########
src/main/java/org/codehaus/groovy/runtime/metaclass/DefaultMetaClassInfo.java:
##########
@@ -29,21 +29,21 @@ public class DefaultMetaClassInfo {
     //                  boolean
     //---------------------------------------------
 
-    // if original boolean meta class
+    // if original boolean metaclass
     private static boolean origBoolean = true;
     // if origBoolean and withoutCustomHandle
     private static boolean origBooleanRes = true;
 
     /**
-     * @return  true if no meta class creation handle is set and if
-     *          the original boolean meta class is used.
+     * @return  true if no metaclass creation handle is set and if

Review Comment:
   
*[MissingSummary](https://google.github.io/styleguide/javaguide.html#s7.2-summary-fragment):*
  A summary fragment is required; consider using the value of the @return block 
as a summary fragment instead.
   
   ---
   
   
   ```suggestion
        *Returns true if no metaclass creation handle is set and if
   ```
   
   
   
   ---
   
   <details><summary><b>ℹī¸ Learn about @sonatype-lift commands</b></summary>
   
   You can reply with the following commands. For example, reply with 
***@sonatype-lift ignoreall*** to leave out all findings.
   | **Command** | **Usage** |
   | ------------- | ------------- |
   | `@sonatype-lift ignore` | Leave out the above finding from this PR |
   | `@sonatype-lift ignoreall` | Leave out all the existing findings from this 
PR |
   | `@sonatype-lift exclude <file\|issue\|path\|tool>` | Exclude specified 
`file\|issue\|path\|tool` from Lift findings by updating your config.toml file |
   
   **Note:** When talking to LiftBot, you need to **refresh** the page to see 
its response.
   <sub>[Click here](https://github.com/apps/sonatype-lift/installations/new) 
to add LiftBot to another repo.</sub></details>
   
   
   
   ---
   
   Was this a good recommendation?
   [ [🙁 Not 
relevant](https://www.sonatype.com/lift-comment-rating?comment=346020845&lift_comment_rating=1)
 ] - [ [😕 Won't 
fix](https://www.sonatype.com/lift-comment-rating?comment=346020845&lift_comment_rating=2)
 ] - [ [😑 Not critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346020845&lift_comment_rating=3)
 ] - [ [🙂 Critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346020845&lift_comment_rating=4)
 ] - [ [😊 Critical, fixing 
now](https://www.sonatype.com/lift-comment-rating?comment=346020845&lift_comment_rating=5)
 ]



##########
src/main/java/org/codehaus/groovy/runtime/metaclass/DefaultMetaClassInfo.java:
##########
@@ -154,21 +154,21 @@ public static void setOrigInt(boolean v) {
     //                  int[]
     //---------------------------------------------
 
-    // if original Integer[] meta class
+    // if original Integer[] metaclass
     private static boolean origIntArray = true;
     // if origInt and withoutCustomHandle
     private static boolean origIntArrayWCH = true;
 
     /**
-     * @return  true if no meta class creation handle is set and if
-     *          the original integer array meta class is used.
+     * @return  true if no metaclass creation handle is set and if

Review Comment:
   
*[MissingSummary](https://google.github.io/styleguide/javaguide.html#s7.2-summary-fragment):*
  A summary fragment is required; consider using the value of the @return block 
as a summary fragment instead.
   
   ---
   
   
   ```suggestion
        *Returns true if no metaclass creation handle is set and if
   ```
   
   
   
   ---
   
   <details><summary><b>ℹī¸ Learn about @sonatype-lift commands</b></summary>
   
   You can reply with the following commands. For example, reply with 
***@sonatype-lift ignoreall*** to leave out all findings.
   | **Command** | **Usage** |
   | ------------- | ------------- |
   | `@sonatype-lift ignore` | Leave out the above finding from this PR |
   | `@sonatype-lift ignoreall` | Leave out all the existing findings from this 
PR |
   | `@sonatype-lift exclude <file\|issue\|path\|tool>` | Exclude specified 
`file\|issue\|path\|tool` from Lift findings by updating your config.toml file |
   
   **Note:** When talking to LiftBot, you need to **refresh** the page to see 
its response.
   <sub>[Click here](https://github.com/apps/sonatype-lift/installations/new) 
to add LiftBot to another repo.</sub></details>
   
   
   
   ---
   
   Was this a good recommendation?
   [ [🙁 Not 
relevant](https://www.sonatype.com/lift-comment-rating?comment=346020884&lift_comment_rating=1)
 ] - [ [😕 Won't 
fix](https://www.sonatype.com/lift-comment-rating?comment=346020884&lift_comment_rating=2)
 ] - [ [😑 Not critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346020884&lift_comment_rating=3)
 ] - [ [🙂 Critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346020884&lift_comment_rating=4)
 ] - [ [😊 Critical, fixing 
now](https://www.sonatype.com/lift-comment-rating?comment=346020884&lift_comment_rating=5)
 ]



##########
src/main/java/org/codehaus/groovy/runtime/metaclass/DefaultMetaClassInfo.java:
##########
@@ -179,21 +179,21 @@ public static void setOrigIntArray(boolean v) {
     //                  long
     //---------------------------------------------
 
-    // if original long meta class
+    // if original long metaclass
     private static boolean origLong = true;
     // if origLong and withoutCustomHandle
     private static boolean origLongRes = true;
 
     /**
-     * @return  true if no meta class creation handle is set and if
-     *          the original long meta class is used.
+     * @return  true if no metaclass creation handle is set and if

Review Comment:
   
*[MissingSummary](https://google.github.io/styleguide/javaguide.html#s7.2-summary-fragment):*
  A summary fragment is required; consider using the value of the @return block 
as a summary fragment instead.
   
   ---
   
   
   ```suggestion
        *Returns true if no metaclass creation handle is set and if
   ```
   
   
   
   ---
   
   <details><summary><b>ℹī¸ Learn about @sonatype-lift commands</b></summary>
   
   You can reply with the following commands. For example, reply with 
***@sonatype-lift ignoreall*** to leave out all findings.
   | **Command** | **Usage** |
   | ------------- | ------------- |
   | `@sonatype-lift ignore` | Leave out the above finding from this PR |
   | `@sonatype-lift ignoreall` | Leave out all the existing findings from this 
PR |
   | `@sonatype-lift exclude <file\|issue\|path\|tool>` | Exclude specified 
`file\|issue\|path\|tool` from Lift findings by updating your config.toml file |
   
   **Note:** When talking to LiftBot, you need to **refresh** the page to see 
its response.
   <sub>[Click here](https://github.com/apps/sonatype-lift/installations/new) 
to add LiftBot to another repo.</sub></details>
   
   
   
   ---
   
   Was this a good recommendation?
   [ [🙁 Not 
relevant](https://www.sonatype.com/lift-comment-rating?comment=346020908&lift_comment_rating=1)
 ] - [ [😕 Won't 
fix](https://www.sonatype.com/lift-comment-rating?comment=346020908&lift_comment_rating=2)
 ] - [ [😑 Not critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346020908&lift_comment_rating=3)
 ] - [ [🙂 Critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346020908&lift_comment_rating=4)
 ] - [ [😊 Critical, fixing 
now](https://www.sonatype.com/lift-comment-rating?comment=346020908&lift_comment_rating=5)
 ]



##########
src/main/java/org/codehaus/groovy/runtime/metaclass/DefaultMetaClassInfo.java:
##########
@@ -229,36 +229,36 @@ public static void setOrigFloat(boolean v) {
     //                  double
     //---------------------------------------------
 
-    // if original double meta class
+    // if original double metaclass
     private static boolean origDouble = true;
     // if origFloat and withoutCustomHandle
     private static boolean origDoubleRes = true;
 
     /**
-     * @return  true if no meta class creation handle is set and if
-     *          the original double meta class is used.
+     * @return  true if no metaclass creation handle is set and if

Review Comment:
   
*[MissingSummary](https://google.github.io/styleguide/javaguide.html#s7.2-summary-fragment):*
  A summary fragment is required; consider using the value of the @return block 
as a summary fragment instead.
   
   ---
   
   
   ```suggestion
        *Returns true if no metaclass creation handle is set and if
   ```
   
   
   
   ---
   
   <details><summary><b>ℹī¸ Learn about @sonatype-lift commands</b></summary>
   
   You can reply with the following commands. For example, reply with 
***@sonatype-lift ignoreall*** to leave out all findings.
   | **Command** | **Usage** |
   | ------------- | ------------- |
   | `@sonatype-lift ignore` | Leave out the above finding from this PR |
   | `@sonatype-lift ignoreall` | Leave out all the existing findings from this 
PR |
   | `@sonatype-lift exclude <file\|issue\|path\|tool>` | Exclude specified 
`file\|issue\|path\|tool` from Lift findings by updating your config.toml file |
   
   **Note:** When talking to LiftBot, you need to **refresh** the page to see 
its response.
   <sub>[Click here](https://github.com/apps/sonatype-lift/installations/new) 
to add LiftBot to another repo.</sub></details>
   
   
   
   ---
   
   Was this a good recommendation?
   [ [🙁 Not 
relevant](https://www.sonatype.com/lift-comment-rating?comment=346021102&lift_comment_rating=1)
 ] - [ [😕 Won't 
fix](https://www.sonatype.com/lift-comment-rating?comment=346021102&lift_comment_rating=2)
 ] - [ [😑 Not critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346021102&lift_comment_rating=3)
 ] - [ [🙂 Critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346021102&lift_comment_rating=4)
 ] - [ [😊 Critical, fixing 
now](https://www.sonatype.com/lift-comment-rating?comment=346021102&lift_comment_rating=5)
 ]



##########
src/main/java/org/codehaus/groovy/runtime/metaclass/DefaultMetaClassInfo.java:
##########
@@ -129,21 +129,21 @@ public static void setOrigShort(boolean v) {
     //                  int
     //---------------------------------------------
 
-    // if original Integer meta class
+    // if original Integer metaclass
     private static boolean origInt = true;
     // if origInt and withoutCustomHandle
     private static boolean origIntRes = true;
 
     /**
-     * @return  true if no meta class creation handle is set and if
-     *          the original integer meta class is used.
+     * @return  true if no metaclass creation handle is set and if

Review Comment:
   
*[MissingSummary](https://google.github.io/styleguide/javaguide.html#s7.2-summary-fragment):*
  A summary fragment is required; consider using the value of the @return block 
as a summary fragment instead.
   
   ---
   
   
   ```suggestion
        *Returns true if no metaclass creation handle is set and if
   ```
   
   
   
   ---
   
   <details><summary><b>ℹī¸ Learn about @sonatype-lift commands</b></summary>
   
   You can reply with the following commands. For example, reply with 
***@sonatype-lift ignoreall*** to leave out all findings.
   | **Command** | **Usage** |
   | ------------- | ------------- |
   | `@sonatype-lift ignore` | Leave out the above finding from this PR |
   | `@sonatype-lift ignoreall` | Leave out all the existing findings from this 
PR |
   | `@sonatype-lift exclude <file\|issue\|path\|tool>` | Exclude specified 
`file\|issue\|path\|tool` from Lift findings by updating your config.toml file |
   
   **Note:** When talking to LiftBot, you need to **refresh** the page to see 
its response.
   <sub>[Click here](https://github.com/apps/sonatype-lift/installations/new) 
to add LiftBot to another repo.</sub></details>
   
   
   
   ---
   
   Was this a good recommendation?
   [ [🙁 Not 
relevant](https://www.sonatype.com/lift-comment-rating?comment=346021238&lift_comment_rating=1)
 ] - [ [😕 Won't 
fix](https://www.sonatype.com/lift-comment-rating?comment=346021238&lift_comment_rating=2)
 ] - [ [😑 Not critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346021238&lift_comment_rating=3)
 ] - [ [🙂 Critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346021238&lift_comment_rating=4)
 ] - [ [😊 Critical, fixing 
now](https://www.sonatype.com/lift-comment-rating?comment=346021238&lift_comment_rating=5)
 ]



##########
src/main/java/org/codehaus/groovy/runtime/metaclass/DefaultMetaClassInfo.java:
##########
@@ -54,21 +54,21 @@ public static void setOrigBool(boolean v) {
     //                  byte
     //---------------------------------------------
 
-    // if original Byte meta class
+    // if original Byte metaclass
     private static boolean origByte = true;
     // if origByte and withoutCustomHandle
     private static boolean origByteRes = true;
 
     /**
-     * @return  true if no meta class creation handle is set and if
-     *          the original byte meta class is used.
+     * @return  true if no metaclass creation handle is set and if

Review Comment:
   
*[MissingSummary](https://google.github.io/styleguide/javaguide.html#s7.2-summary-fragment):*
  A summary fragment is required; consider using the value of the @return block 
as a summary fragment instead.
   
   ---
   
   
   ```suggestion
        *Returns true if no metaclass creation handle is set and if
   ```
   
   
   
   ---
   
   <details><summary><b>ℹī¸ Learn about @sonatype-lift commands</b></summary>
   
   You can reply with the following commands. For example, reply with 
***@sonatype-lift ignoreall*** to leave out all findings.
   | **Command** | **Usage** |
   | ------------- | ------------- |
   | `@sonatype-lift ignore` | Leave out the above finding from this PR |
   | `@sonatype-lift ignoreall` | Leave out all the existing findings from this 
PR |
   | `@sonatype-lift exclude <file\|issue\|path\|tool>` | Exclude specified 
`file\|issue\|path\|tool` from Lift findings by updating your config.toml file |
   
   **Note:** When talking to LiftBot, you need to **refresh** the page to see 
its response.
   <sub>[Click here](https://github.com/apps/sonatype-lift/installations/new) 
to add LiftBot to another repo.</sub></details>
   
   
   
   ---
   
   Was this a good recommendation?
   [ [🙁 Not 
relevant](https://www.sonatype.com/lift-comment-rating?comment=346021485&lift_comment_rating=1)
 ] - [ [😕 Won't 
fix](https://www.sonatype.com/lift-comment-rating?comment=346021485&lift_comment_rating=2)
 ] - [ [😑 Not critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346021485&lift_comment_rating=3)
 ] - [ [🙂 Critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346021485&lift_comment_rating=4)
 ] - [ [😊 Critical, fixing 
now](https://www.sonatype.com/lift-comment-rating?comment=346021485&lift_comment_rating=5)
 ]



##########
src/main/java/org/codehaus/groovy/runtime/metaclass/DefaultMetaClassInfo.java:
##########
@@ -79,21 +79,21 @@ public static void setOrigByte(boolean v) {
     //                  char
     //---------------------------------------------
 
-    // if original char meta class
+    // if original char metaclass
     private static boolean origChar = true;
     // if origChar and withoutCustomHandle
     private static boolean origCharRes = true;
 
     /**
-     * @return  true if no meta class creation handle is set and if
-     *          the original char meta class is used.
+     * @return  true if no metaclass creation handle is set and if

Review Comment:
   
*[MissingSummary](https://google.github.io/styleguide/javaguide.html#s7.2-summary-fragment):*
  A summary fragment is required; consider using the value of the @return block 
as a summary fragment instead.
   
   ---
   
   
   ```suggestion
        *Returns true if no metaclass creation handle is set and if
   ```
   
   
   
   ---
   
   <details><summary><b>ℹī¸ Learn about @sonatype-lift commands</b></summary>
   
   You can reply with the following commands. For example, reply with 
***@sonatype-lift ignoreall*** to leave out all findings.
   | **Command** | **Usage** |
   | ------------- | ------------- |
   | `@sonatype-lift ignore` | Leave out the above finding from this PR |
   | `@sonatype-lift ignoreall` | Leave out all the existing findings from this 
PR |
   | `@sonatype-lift exclude <file\|issue\|path\|tool>` | Exclude specified 
`file\|issue\|path\|tool` from Lift findings by updating your config.toml file |
   
   **Note:** When talking to LiftBot, you need to **refresh** the page to see 
its response.
   <sub>[Click here](https://github.com/apps/sonatype-lift/installations/new) 
to add LiftBot to another repo.</sub></details>
   
   
   
   ---
   
   Was this a good recommendation?
   [ [🙁 Not 
relevant](https://www.sonatype.com/lift-comment-rating?comment=346021513&lift_comment_rating=1)
 ] - [ [😕 Won't 
fix](https://www.sonatype.com/lift-comment-rating?comment=346021513&lift_comment_rating=2)
 ] - [ [😑 Not critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346021513&lift_comment_rating=3)
 ] - [ [🙂 Critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346021513&lift_comment_rating=4)
 ] - [ [😊 Critical, fixing 
now](https://www.sonatype.com/lift-comment-rating?comment=346021513&lift_comment_rating=5)
 ]



##########
src/main/java/org/codehaus/groovy/runtime/metaclass/DefaultMetaClassInfo.java:
##########
@@ -204,21 +204,21 @@ public static void setOrigLong(boolean v) {
     //                  float
     //---------------------------------------------
 
-    // if original float meta class
+    // if original float metaclass
     private static boolean origFloat = true;
     // if origFloat and withoutCustomHandle
     private static boolean origFloatRes = true;
 
     /**
-     * @return  true if no meta class creation handle is set and if
-     *          the original float meta class is used.
+     * @return  true if no metaclass creation handle is set and if

Review Comment:
   
*[MissingSummary](https://google.github.io/styleguide/javaguide.html#s7.2-summary-fragment):*
  A summary fragment is required; consider using the value of the @return block 
as a summary fragment instead.
   
   ---
   
   
   ```suggestion
        *Returns true if no metaclass creation handle is set and if
   ```
   
   
   
   ---
   
   <details><summary><b>ℹī¸ Learn about @sonatype-lift commands</b></summary>
   
   You can reply with the following commands. For example, reply with 
***@sonatype-lift ignoreall*** to leave out all findings.
   | **Command** | **Usage** |
   | ------------- | ------------- |
   | `@sonatype-lift ignore` | Leave out the above finding from this PR |
   | `@sonatype-lift ignoreall` | Leave out all the existing findings from this 
PR |
   | `@sonatype-lift exclude <file\|issue\|path\|tool>` | Exclude specified 
`file\|issue\|path\|tool` from Lift findings by updating your config.toml file |
   
   **Note:** When talking to LiftBot, you need to **refresh** the page to see 
its response.
   <sub>[Click here](https://github.com/apps/sonatype-lift/installations/new) 
to add LiftBot to another repo.</sub></details>
   
   
   
   ---
   
   Was this a good recommendation?
   [ [🙁 Not 
relevant](https://www.sonatype.com/lift-comment-rating?comment=346021577&lift_comment_rating=1)
 ] - [ [😕 Won't 
fix](https://www.sonatype.com/lift-comment-rating?comment=346021577&lift_comment_rating=2)
 ] - [ [😑 Not critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346021577&lift_comment_rating=3)
 ] - [ [🙂 Critical, will 
fix](https://www.sonatype.com/lift-comment-rating?comment=346021577&lift_comment_rating=4)
 ] - [ [😊 Critical, fixing 
now](https://www.sonatype.com/lift-comment-rating?comment=346021577&lift_comment_rating=5)
 ]



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to