[GitHub] [commons-net] garydgregory commented on a diff in pull request #141: Fixes many grammar issues and typos in JavaDoc and code comments
garydgregory commented on code in PR #141:
URL: https://github.com/apache/commons-net/pull/141#discussion_r1070608034
##
src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java:
##
@@ -110,7 +110,7 @@ public class UnixFTPEntryParser extends
ConfigurableFTPFileEntryParserImpl {
/**
* The default constructor for a UnixFTPEntryParser object.
*
- * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. It it is seen, this is
a
+ * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. If it is seen, this is
a
Review Comment:
Hm, then if I was confused by what "it" refers to, can we replace the "it"
with the actual subject?
--
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: issues-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-net] garydgregory commented on a diff in pull request #141: Fixes many grammar issues and typos in JavaDoc and code comments
garydgregory commented on code in PR #141:
URL: https://github.com/apache/commons-net/pull/141#discussion_r1070581110
##
src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java:
##
@@ -110,7 +110,7 @@ public class UnixFTPEntryParser extends
ConfigurableFTPFileEntryParserImpl {
/**
* The default constructor for a UnixFTPEntryParser object.
*
- * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. It it is seen, this is
a
+ * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. If it is seen, this is
a
Review Comment:
Up to you. When you are done with edits here, I will review the PR again
(hopefully for the last time).
--
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: issues-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-net] garydgregory commented on a diff in pull request #141: Fixes many grammar issues and typos in JavaDoc and code comments
garydgregory commented on code in PR #141:
URL: https://github.com/apache/commons-net/pull/141#discussion_r1070580429
##
src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java:
##
@@ -110,7 +110,7 @@ public class UnixFTPEntryParser extends
ConfigurableFTPFileEntryParserImpl {
/**
* The default constructor for a UnixFTPEntryParser object.
*
- * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. It it is seen, this is
a
+ * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. If it is seen, this is
a
Review Comment:
Might this be better: "If it is seen" -> "If it is thrown"
--
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: issues-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-net] garydgregory commented on a diff in pull request #141: Fixes many grammar issues and typos in JavaDoc and code comments
garydgregory commented on code in PR #141:
URL: https://github.com/apache/commons-net/pull/141#discussion_r1070441477
##
src/main/java/org/apache/commons/net/ftp/FTPSClient.java:
##
@@ -204,7 +204,7 @@ public FTPSClient(final String protocol, final boolean
isImplicit) {
/**
* Because there are so many connect() methods, the _connectAction_()
method is provided as a means of performing some action immediately after
establishing
- * a connection, rather than reimplementing all of the connect() methods.
+ * a connection, rather than reimplementing all the connect() methods.
*
* @throws IOException If it throw by _connectAction_.
Review Comment:
> That's what was there before. Any suggestion how that should be formulated?
Use a JDK method as a template
--
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: issues-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-net] garydgregory commented on a diff in pull request #141: Fixes many grammar issues and typos in JavaDoc and code comments
garydgregory commented on code in PR #141:
URL: https://github.com/apache/commons-net/pull/141#discussion_r1070388783
##
src/main/java/org/apache/commons/net/ftp/FTPSClient.java:
##
@@ -204,7 +204,7 @@ public FTPSClient(final String protocol, final boolean
isImplicit) {
/**
* Because there are so many connect() methods, the _connectAction_()
method is provided as a means of performing some action immediately after
establishing
- * a connection, rather than reimplementing all of the connect() methods.
+ * a connection, rather than reimplementing all the connect() methods.
*
* @throws IOException If it throw by _connectAction_.
Review Comment:
"If it throw by _connectAction_." Still not correct.
--
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: issues-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-net] garydgregory commented on a diff in pull request #141: Fixes many grammar issues and typos in JavaDoc and code comments
garydgregory commented on code in PR #141:
URL: https://github.com/apache/commons-net/pull/141#discussion_r1070388783
##
src/main/java/org/apache/commons/net/ftp/FTPSClient.java:
##
@@ -204,7 +204,7 @@ public FTPSClient(final String protocol, final boolean
isImplicit) {
/**
* Because there are so many connect() methods, the _connectAction_()
method is provided as a means of performing some action immediately after
establishing
- * a connection, rather than reimplementing all of the connect() methods.
+ * a connection, rather than reimplementing all the connect() methods.
*
* @throws IOException If it throw by _connectAction_.
Review Comment:
Still not correct.
--
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: issues-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-net] garydgregory commented on a diff in pull request #141: Fixes many grammar issues and typos in JavaDoc and code comments
garydgregory commented on code in PR #141:
URL: https://github.com/apache/commons-net/pull/141#discussion_r1070388572
##
src/main/java/org/apache/commons/net/nntp/NNTPClient.java:
##
@@ -583,12 +583,12 @@ private void parseArticlePointer(final String reply,
final ArticleInfo pointer)
* due to malformed headers.
*
* You must not issue any commands to the NNTP server (i.e., call any
(other methods) until you finish writing to the returned Writer instance and
close it.
- * The NNTP protocol uses the same stream for issuing commands as it does
for returning results. Therefore the returned Writer actually writes directly to
+ * The NNTP protocol uses the same stream for issuing commands as it does
for returning results. Therefore, the returned Writer actually writes directly
to
* the NNTP connection. After you close the writer, you can execute new
commands. If you do not follow these requirements your program will not work
* properly.
*
* Different NNTP servers will require different header formats, but you
can use the provided {@link org.apache.commons.net.nntp.SimpleNNTPHeader} class
to
- * construct the bare minimum acceptable header for most news readers. To
construct more complicated headers you should refer to RFC 822. When the Java
Mail
+ * construct the bare minimum acceptable header for most newsreaders. To
construct more complicated headers you should refer to RFC 822. When the Java
Mail
Review Comment:
Gross, but ok I guess.
--
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: issues-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-net] garydgregory commented on a diff in pull request #141: Fixes many grammar issues and typos in JavaDoc and code comments
garydgregory commented on code in PR #141: URL: https://github.com/apache/commons-net/pull/141#discussion_r1069940736 ## src/main/java/org/apache/commons/net/nntp/Threader.java: ## @@ -56,29 +55,29 @@ private void buildContainer(final Threadable threadable, final HashMap
[GitHub] [commons-net] garydgregory commented on a diff in pull request #141: Fixes many grammar issues and typos in JavaDoc and code comments
garydgregory commented on code in PR #141:
URL: https://github.com/apache/commons-net/pull/141#discussion_r1069940079
##
src/main/java/org/apache/commons/net/nntp/NewGroupsOrNewsQuery.java:
##
@@ -246,7 +246,7 @@ public boolean isGMT() {
*
*
*
- * @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:
Why "fresh" before and "recent" here? Using "recent" for both would be more
consistent IMO.
--
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: issues-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-net] garydgregory commented on a diff in pull request #141: Fixes many grammar issues and typos in JavaDoc and code comments
garydgregory commented on code in PR #141: URL: https://github.com/apache/commons-net/pull/141#discussion_r1069939428 ## src/main/java/org/apache/commons/net/nntp/NNTPClient.java: ## @@ -1283,7 +1283,7 @@ public boolean selectArticle(final long articleNumber, final ArticleInfo pointer /** * Same as selectArticle(articleId, (ArticleInfo) null) * - * @param articleId the article Id + * @param articleId the article's identifier Review Comment: Superfluous change IMO, this change makes the text wordier, it was clearer to me previously. -- 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: issues-unsubscr...@commons.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [commons-net] garydgregory commented on a diff in pull request #141: Fixes many grammar issues and typos in JavaDoc and code comments
garydgregory commented on code in PR #141:
URL: https://github.com/apache/commons-net/pull/141#discussion_r1069937369
##
src/main/java/org/apache/commons/net/nntp/NNTPClient.java:
##
@@ -583,12 +583,12 @@ private void parseArticlePointer(final String reply,
final ArticleInfo pointer)
* due to malformed headers.
*
* You must not issue any commands to the NNTP server (i.e., call any
(other methods) until you finish writing to the returned Writer instance and
close it.
- * The NNTP protocol uses the same stream for issuing commands as it does
for returning results. Therefore the returned Writer actually writes directly to
+ * The NNTP protocol uses the same stream for issuing commands as it does
for returning results. Therefore, the returned Writer actually writes directly
to
* the NNTP connection. After you close the writer, you can execute new
commands. If you do not follow these requirements your program will not work
* properly.
*
* Different NNTP servers will require different header formats, but you
can use the provided {@link org.apache.commons.net.nntp.SimpleNNTPHeader} class
to
- * construct the bare minimum acceptable header for most news readers. To
construct more complicated headers you should refer to RFC 822. When the Java
Mail
+ * construct the bare minimum acceptable header for most newsreaders. To
construct more complicated headers you should refer to RFC 822. When the Java
Mail
Review Comment:
"newsreaders" is not a word AFAIK
--
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: issues-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-net] garydgregory commented on a diff in pull request #141: Fixes many grammar issues and typos in JavaDoc and code comments
garydgregory commented on code in PR #141:
URL: https://github.com/apache/commons-net/pull/141#discussion_r1069936269
##
src/main/java/org/apache/commons/net/imap/IMAP.java:
##
@@ -374,7 +374,7 @@ public int sendCommand(final String command, final String
args) throws IOExcepti
* @param commandID The ID (tag) of the command.
* @param command The IMAP command to send.
* @param args The command arguments.
- * @return The server reply code (either IMAPReply.OK, IMAPReply.NO or
IMAPReply.BAD).
+ * @return The server reply code (either {@code IMAPReply.OK}, {@code
IMAPReply.NO} or {@code IMAPReply.BAD}).
Review Comment:
Probably use @link for these.
--
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: issues-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-net] garydgregory commented on a diff in pull request #141: Fixes many grammar issues and typos in JavaDoc and code comments
garydgregory commented on code in PR #141:
URL: https://github.com/apache/commons-net/pull/141#discussion_r1069934957
##
src/main/java/org/apache/commons/net/ftp/parser/MLSxEntryParser.java:
##
@@ -234,7 +234,7 @@ public FTPFile parseFTPEntry(final String entry) {
if (intType == null) {
file.setType(FTPFile.UNKNOWN_TYPE);
} else {
-file.setType(intType.intValue());
+file.setType(intType);
Review Comment:
Please leave boxing/unboxing alone.
--
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: issues-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-net] garydgregory commented on a diff in pull request #141: Fixes many grammar issues and typos in JavaDoc and code comments
garydgregory commented on code in PR #141:
URL: https://github.com/apache/commons-net/pull/141#discussion_r1069934643
##
src/main/java/org/apache/commons/net/ftp/parser/MLSxEntryParser.java:
##
@@ -64,10 +64,10 @@ public class MLSxEntryParser extends FTPFileEntryParserImpl
{
private static final HashMap TYPE_TO_INT = new
HashMap<>();
static {
-TYPE_TO_INT.put("file", Integer.valueOf(FTPFile.FILE_TYPE));
Review Comment:
Don't change this code: leave boxing/unboxing alone.
--
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: issues-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-net] garydgregory commented on a diff in pull request #141: Fixes many grammar issues and typos in JavaDoc and code comments
garydgregory commented on code in PR #141:
URL: https://github.com/apache/commons-net/pull/141#discussion_r1069933842
##
src/main/java/org/apache/commons/net/ftp/FTPSClient.java:
##
@@ -204,9 +204,9 @@ public FTPSClient(final String protocol, final boolean
isImplicit) {
/**
* Because there are so many connect() methods, the _connectAction_()
method is provided as a means of performing some action immediately after
establishing
- * a connection, rather than reimplementing all of the connect() methods.
+ * a connection, rather than reimplementing all the connect() methods.
*
- * @throws IOException If it throw by _connectAction_.
+ * @throws IOException If it throws by _connectAction_.
Review Comment:
Err...?
--
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: issues-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
