[GitHub] [accumulo] ctubbsii commented on a diff in pull request #2724: Use href links in Javadoc

[GitBox <gi...@apache.org>]

ctubbsii commented on code in PR #2724:
URL: https://github.com/apache/accumulo/pull/2724#discussion_r879848779


##########
core/src/main/java/org/apache/accumulo/core/client/Accumulo.java:
##########
@@ -70,8 +70,9 @@ private Accumulo() {}
    * </code>
    * </pre>
    *
-   * For a list of all client properties see the documentation on the Accumulo website:
-   * https://accumulo.apache.org/docs/2.x/configuration/client-properties
+   * For a list of all client properties see the documentation on the

Review Comment:
   ```suggestion
      * For a list of all client properties, see the documentation on the
   ```



##########
core/src/main/java/org/apache/accumulo/core/client/Accumulo.java:
##########
@@ -90,8 +91,9 @@ public static AccumuloClient.PropertyOptions<AccumuloClient> newClient() {
    * </code>
    * </pre>
    *
-   * For a list of all client properties see the documentation on the Accumulo website:
-   * https://accumulo.apache.org/docs/2.x/configuration/client-properties
+   * For a list of all client properties see the documentation on the

Review Comment:
   ```suggestion
      * For a list of all client properties, see the documentation on the
   ```



##########
core/src/main/java/org/apache/accumulo/core/clientImpl/TableOperationsImpl.java:
##########
@@ -1620,8 +1620,8 @@ public void importTable(String tableName, Set<String> importDirs)
   }
 
   /**
-   * Prevent potential CRLF injection into logs from read in user data See
-   * https://find-sec-bugs.github.io/bugs.htm#CRLF_INJECTION_LOGS
+   * Prevent potential CRLF injection into logs from read in user data. See
+   * <a href="https://find-sec-bugs.github.io/bugs.htm#CRLF_INJECTION_LOGS">bug description</a>

Review Comment:
   This also works, and doesn't require coming up with a good text description for the link:
   
   ```suggestion
      * Prevent potential CRLF injection into logs from read in user data.
      *
      * @see https://find-sec-bugs.github.io/bugs.htm#CRLF_INJECTION_LOGS
   ```



##########
server/manager/src/main/java/org/apache/accumulo/manager/tableOps/tableImport/ImportTable.java:
##########
@@ -53,8 +53,9 @@
 
 /**
  * Serialization updated for supporting multiple volumes in import table from 1L to 2L See:
- * https://github.com/apache/accumulo/issues/1053 https://github.com/apache/accumulo/pull/1060
- * https://github.com/apache/accumulo/issues/1576
+ * <a href="https://github.com/apache/accumulo/issues/1053">1053</a>
+ * <a href="https://github.com/apache/accumulo/pull/1060">1060</a>
+ * <a href="https://github.com/apache/accumulo/issues/1576">1576</a>

Review Comment:
   None of these are needed. We don't need to embed references to historical changes to the code in the code itself. The git history does that already. This would get out of hand if we did this more often. These references can just be removed.



-- 
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: notifications-unsubscribe@accumulo.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org