sigram commented on a change in pull request #789: LUCENE-8915 : Improve
Javadocs for RateLimiter and SimpleRateLimiter
URL: https://github.com/apache/lucene-solr/pull/789#discussion_r304360145
##########
File path: lucene/core/src/java/org/apache/lucene/store/RateLimiter.java
##########
@@ -47,7 +49,11 @@
* */
public abstract long pause(long bytes) throws IOException;
- /** How many bytes caller should add up itself before invoking {@link
#pause}. */
+ /** How many bytes caller should add up itself before invoking {@link
#pause}.
+ * NOTE: The value returned by this method may change over time and is not
guaranteed
+ * to be constant throughout the lifetime of the RateLimiter. Users are
advised to
+ * refresh their local values with calls to this method to ensure
consistency
Review comment:
Overall, LGTM, +1.
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
