raboof commented on code in PR #308:
URL: https://github.com/apache/commons-validator/pull/308#discussion_r1901040080
##########
src/main/java/org/apache/commons/validator/util/Flags.java:
##########
@@ -176,7 +176,7 @@ public void turnOffAll() {
}
/**
- * Turns on the given flag. If the flag is not a power of 2 (ie. 3) this
+ * Turns on the given flag. If the flag is not a power of 2 (that is, 3)
this
Review Comment:
```suggestion
* Turns on the given flag. If the flag is not a power of 2 (for
example, 3) this
```
##########
src/main/java/org/apache/commons/validator/util/Flags.java:
##########
@@ -132,8 +132,8 @@ public boolean isOff(final long flag) {
}
/**
- * Tests whether the given flag is on. If the flag is not a power of 2
- * (ie. 3) this tests whether the combination of flags is on.
+ * Tests whether the given flag is on. If the flag is not a power of 2
+ * (that is, 3) this tests whether the combination of flags is on.
Review Comment:
```suggestion
* (for example, 3) this tests whether the combination of flags is on.
```
##########
src/main/java/org/apache/commons/validator/util/Flags.java:
##########
@@ -159,7 +159,7 @@ public String toString() {
}
/**
- * Turns off the given flag. If the flag is not a power of 2 (ie. 3) this
+ * Turns off the given flag. If the flag is not a power of 2 (that is, 3)
this
Review Comment:
```suggestion
* Turns off the given flag. If the flag is not a power of 2 (for
example, 3) this
```
##########
src/main/java/org/apache/commons/validator/routines/UrlValidator.java:
##########
@@ -131,7 +131,7 @@ public class UrlValidator implements Serializable {
private static final String AUTHORITY_REGEX =
"(?:\\[(" + IPV6_REGEX + ")\\]|(?:(?:" + USERINFO_FIELD_REGEX +
")?([" + AUTHORITY_CHARS_REGEX + "]*)))(?::(\\d*))?(.*)?";
- // 1 e.g. user:pass@
2 3 4
+ // 1 for example, user:pass@
2 3 4
Review Comment:
I think you need to remove some spaces here to make the numbers line up with
the regex again
##########
src/main/java/org/apache/commons/validator/util/Flags.java:
##########
@@ -121,8 +121,8 @@ public int hashCode() {
}
/**
- * Tests whether the given flag is off. If the flag is not a power of 2
- * (ie. 3) this tests whether the combination of flags is off.
+ * Tests whether the given flag is off. If the flag is not a power of 2
+ * (that is, 3) this tests whether the combination of flags is off.
Review Comment:
```suggestion
* (for example, 3) this tests whether the combination of flags is off.
```
##########
src/main/java/org/apache/commons/validator/routines/package-info.java:
##########
@@ -420,8 +420,8 @@
* of the matched <em>groups</em> or {@code null} if invalid.</li>
* </ul>
* </li>
- * <li><strong>Case Sensitivity</strong> - matching can be done in either a
<i>case
- * sensitive</i> or <em>case in-sensitive</em> way.</li>
+ * <li><strong>Case Sensitivity</strong> - matching can be done in either a
+ * <i>case-sensitive</i> or <em>case in-sensitive</em> way.</li>
Review Comment:
```suggestion
* <i>case-sensitive</i> or <em>case-insensitive</em> way.</li>
```
##########
src/main/java/org/apache/commons/validator/routines/checkdigit/ISBNCheckDigit.java:
##########
@@ -68,7 +68,7 @@ public ISBNCheckDigit() {
* @return The ISBN-10 check digit if the length is 9 or an ISBN-13
* check digit if the length is 12.
* @throws CheckDigitException if the code is missing, or an invalid
- * length (i.e. not 9 or 12) or if there is an error calculating the
+ * length (that is not 9 or 12) or if there is an error calculating the
Review Comment:
```suggestion
* length (that is, not 9 or 12) or if there is an error calculating the
```
##########
src/main/java/org/apache/commons/validator/routines/ISBNValidator.java:
##########
@@ -220,7 +220,7 @@ public boolean isValidISBN13(final String code) {
* Check the code is either a valid ISBN-10 or ISBN-13 code.
* <p>
* If valid, this method returns the ISBN code with
- * formatting characters removed (i.e. space or hyphen).
+ * formatting characters removed (such as space or hyphen).
Review Comment:
are you sure other formatting characters than spaces or hyphens are indeed
removed?
##########
src/main/java/org/apache/commons/validator/routines/checkdigit/VerhoeffCheckDigit.java:
##########
@@ -96,7 +96,7 @@ public String calculate(final String code) throws
CheckDigitException {
* @param code The code to calculate the checksum for.
* @param includesCheckDigit Whether the code includes the Check Digit or
not.
* @return The checksum value
- * @throws CheckDigitException if the code contains an invalid character
(i.e. not numeric)
+ * @throws CheckDigitException if the code contains an invalid character
(that is not numeric)
Review Comment:
```suggestion
* @throws CheckDigitException if the code contains an invalid character
(that is, a non-numeric character)
```
##########
src/main/java/org/apache/commons/validator/routines/package-info.java:
##########
@@ -369,7 +369,7 @@
* </pre>
* <p>
* <strong>Note</strong>: in theory the other numeric validators besides
- * <em>Float</em>, <em>Double</em> and <em>BigDecimal</em> (i.e. <em>Byte</em>,
+ * <em>Float</em>, <em>Double</em> and <em>BigDecimal</em> (that is,
<em>Byte</em>,
Review Comment:
the question is whether "<em>Byte</em>, <em>Short</em>, <em>Integer</em>,
<em>Long</em> and <em>BigInteger</em>" is the full list of "the other numeric
validators besides <em>Float</em>, <em>Double</em> and <em>BigDecimal</em>", or
just a list of examples.
Looking at the code this is indeed the full list, so `that is` seems correct
to me.
--
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]
