dsmiley commented on a change in pull request #2442:
URL: https://github.com/apache/lucene-solr/pull/2442#discussion_r588505022
##########
File path:
solr/solrj/src/java/org/apache/solr/client/solrj/impl/BaseCloudSolrClient.java
##########
@@ -91,6 +91,12 @@
import static org.apache.solr.common.params.CommonParams.ADMIN_PATHS;
import static org.apache.solr.common.params.CommonParams.ID;
+/**
+ * If you don't call the {@link #setIdField(String)} method and
+ * if your collection's document router has no route field then
+ * this class assumes the id field for your documents is called
+ * 'id'.
+ */
Review comment:
Javadocs, particularly class javadocs, should start with a sentence
about what this class is / is-for. The javadoc you have here describes some
details that is relevant but not something to *start* javadoc with. So please
add a sentence like "Base SolrClient for implementations optimized for
SolrCloud.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
