garydgregory commented on a change in pull request #144: [COLLECTIONS-757]
Update the JavaDoc of the BidiMap
URL:
https://github.com/apache/commons-collections/pull/144#discussion_r410220989
##########
File path:
src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java
##########
@@ -782,7 +782,7 @@ private static boolean isBlack(final Node<?, ?> node,
final DataElement dataElem
}
/**
- * force a node (if it exists) red
+ * Force a node (if it exists) red.
Review comment:
If a method starts with "make...", it usually reads better to start the
Javadoc with "Makes..." IMO, It's confusing to have the Javadoc be different,
otherwise you could say that all method that start with "set..." also "forces"
a value.
----------------------------------------------------------------
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:
[email protected]
With regards,
Apache Git Services
