sebbASF commented on code in PR #141:
URL: https://github.com/apache/commons-net/pull/141#discussion_r1070574537
##########
src/main/java/org/apache/commons/net/ftp/FTPSClient.java:
##########
@@ -375,7 +375,7 @@ public int execADAT(final byte[] data) throws IOException {
/**
* AUTH command.
*
- * @throws SSLException If it server reply code not equal "234" and "334".
+ * @throws SSLException If the server reply code does not equal "234" and
"334".
Review Comment:
```Does not equal “234” and “334”``` will never be true.
This should be
```Does not equal either of “234” or “334”```
Or
```Does not equal “234” and does not equal “334”```
Or
```Is equal to neither “234” nor “334”```
##########
src/main/java/org/apache/commons/net/nntp/NNTPClient.java:
##########
@@ -416,7 +416,7 @@ public String listHelp() throws IOException {
}
/**
- * List all new articles added to the NNTP server since a particular date
subject to the conditions of the specified query. If no new new news is found, a
+ * List all new articles added to the NNTP server since a particular date
subject to the conditions of the specified query. If no recent news is found, a
Review Comment:
News that is new is not necessarily recent. That depends on the date
##########
src/main/java/org/apache/commons/net/SocketClient.java:
##########
@@ -632,7 +632,7 @@ public void setDefaultPort(final int port) {
/**
* Set the default timeout in milliseconds to use when opening a socket.
This value is only used previous to a call to {@link #connect connect()} and
should
- * not be confused with {@link #setSoTimeout setSoTimeout()} which
operates on an the currently opened socket. _timeout_ contains the new timeout
value.
+ * not be confused with {@link #setSoTimeout setSoTimeout()} which
operates on any of the currently opened socket. _timeout_ contains the new
timeout value.
Review Comment:
That is the wrong fix. Instead the word ‘an’ should just have been deleted.
##########
src/main/java/org/apache/commons/net/telnet/Telnet.java:
##########
@@ -666,7 +666,7 @@ boolean requestedWill(final int option) {
/**
* Looks for the state of the option.
*
- * @return returns true if a wont has been reuqested
+ * @return returns true if a won't has been requested
Review Comment:
The command is “wont”, not “won’t”. Though maybe the commands should be
listed as “WONT”
##########
src/main/java/org/apache/commons/net/smtp/SimpleSMTPHeader.java:
##########
@@ -90,8 +90,8 @@ public void addCC(final String address) {
}
/**
- * Adds an arbitrary header field with the given value to the article
header. These headers will be written before the From, To, Subject, and Cc
fields when
- * the SimpleSMTPHeader is convertered to a string. An example use would
be:
+ * Adds an arbitrary header field with the given value to the article
header. These headers will be written before the
+ * {@code From}, To, Subject, and Cc fields when the SimpleSMTPHeader is
converted to a string. An example use would be:
Review Comment:
Why only add code to From?
##########
src/main/java/org/apache/commons/net/ftp/parser/MVSFTPEntryParser.java:
##########
@@ -437,7 +437,7 @@ private FTPFile parseMemberList(final String entry) {
}
/**
- * preParse is called as part of the interface. Per definition is is
called before the parsing takes place. Three kind of lists is recognize:
z/OS-MVS File
+ * preParse is called as part of the interface. Per definition it is
called before the parsing takes place. Three kind of lists are recognize:
z/OS-MVS File
Review Comment:
Three kindS of list are recogniseD - caps show missing letters
##########
src/main/java/org/apache/commons/net/examples/unix/rlogin.java:
##########
@@ -25,14 +25,14 @@
/**
* This is an example program demonstrating how to use the RLoginClient class.
This program connects to an rlogin daemon and begins to interactively read input
* from stdin (this will be line buffered on most systems, so don't expect
character at a time interactivity), passing it to the remote login process and
- * writing the remote stdout and stderr to local stdout. If you don't have
.rhosts or hosts.equiv files set up, the rlogin daemon will prompt you for a
- * password.
+ * writing the remote stdout and stderr to local stdout. If you don't have
{@code .rhosts} or {@code hosts.equiv} files set up, the rlogin daemon will
prompt
+ * you for a password.
* <p>
* On Unix systems you will not be able to use the rshell capability unless
the process runs as root since only root can bind port addresses lower than
1024.
* <p>
* JVM's using green threads will likely have problems if the rlogin daemon
requests a password. This program is merely a demonstration and is not suitable
for
- * use as an application, especially given that it relies on line buffered
input from System.in. The best way to run this example is probably from a Win95
dos
- * box into a Unix host.
+ * use as an application, especially given that it relies on line-buffered
input from System.in. The best way to run this example is probably from a Win95
+ * dos box into a Unix host.
Review Comment:
Dos => DOS, Win95 => Windows
##########
src/main/java/org/apache/commons/net/ntp/TimeStamp.java:
##########
@@ -210,7 +210,7 @@ public static String toString(final long ntpTime) {
}
/**
- * NTP timestamp value: 64-bit unsigned fixed-point number as defined in
RFC-1305 with high-order 32 bits the seconds field and the low-order 32-bits the
+ * NTP timestamp value: 64-bit unsigned fixed-point number than defined in
RFC-1305 with high-order 32 bits the seconds field and the low-order 32-bits the
Review Comment:
The original is correct here. ‘than’ does not make sense.
##########
src/main/java/org/apache/commons/net/smtp/SMTP.java:
##########
@@ -393,7 +393,7 @@ public int rcpt(final String forwardPath) throws
IOException {
/**
* Removes a ProtocolCommandListener.
*
- * Delegates this incorrectly named method - removeProtocolCommandistener
(note the missing "L")- to the correct method
+ * Delegates this incorrectly named method - removeProtocolCommandListener
(note the missing "L")- to the correct method
Review Comment:
The original was correct. See the parenthesised comment.
##########
src/main/java/org/apache/commons/net/ftp/parser/MVSFTPEntryParser.java:
##########
@@ -248,7 +248,7 @@ protected FTPClientConfig getDefaultConfiguration() {
* ----------------------------------- Group within Regex [1] Volume [2]
Unit [3] Referred [4] Ext: number of extents [5] Used [6] Recfm: Record format
[7]
* Lrecl: Logical record length [8] BlkSz: Block size [9] Dsorg: Dataset
organisation. Many exists but only support: PS, PO, PO-E [10] Dsname: Dataset
name
*
- * Note: When volume is ARCIVE, it means the dataset is stored somewhere
in a tape archive. These entries is currently not supported by this parser. A
null
+ * Note: When volume is ARCIVE, it means the dataset is stored somewhere
in a tape archive. These entries are currently not supported by this parser. A
null
Review Comment:
Should ARCIVE be ARCHIVE?
##########
src/main/java/org/apache/commons/net/nntp/NNTPClient.java:
##########
@@ -268,9 +268,9 @@ public Iterable<Article> iterateArticleInfo(final long
lowArticleNumber, final l
}
/**
- * List all new articles added to the NNTP server since a particular date
subject to the conditions of the specified query. If no new new news is found,
no
- * entries will be returned. This uses the "NEWNEWS" command. You must add
at least one newsgroup to the query, else the command will fail. Each String
- * which is returned is a unique message identifier including the
enclosing < and >.
+ * List all new articles added to the NNTP server since a particular date
subject to the conditions of the specified query. If no recent news is found,
Review Comment:
News that is new is not necessarily recent. That depends on the date.
##########
src/main/java/org/apache/commons/net/nntp/NewGroupsOrNewsQuery.java:
##########
@@ -246,7 +246,7 @@ public boolean isGMT() {
* </pre>
* <p>
*
- * @param newsgroup The newsgroup to add to the list of groups to be
checked for new news, but which should be omitted from the search for new news..
+ * @param newsgroup The newsgroup to add to the list of groups to be
checked for new news, but which should be omitted from the search for recent
news.
Review Comment:
News that is new is not necessarily recent. That depends on the date
--
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]
