iilyak-ibm commented on code in PR #5646: URL: https://github.com/apache/couchdb/pull/5646#discussion_r2334398874
########## src/couch_scanner/src/couch_scanner_rate_limiter.erl: ########## @@ -21,6 +21,18 @@ % % [1] https://en.wikipedia.org/wiki/Additive_increase/multiplicative_decrease % +% Example of usage: +% +% initialize: +% Limiter = couch_scanner_rate_limiter:get(), +% +% use: +% bulk_docs(#{docs => [doc1, doc2, doc3]}), +% {Wait, Limiter1} = couch_scanner_rate_limiter:update(Limiter, doc_write, 3), +% timer:sleep(Wait) +% or +% receive .... after Wait -> ... end +% Review Comment: Please mention all possible values for second argument of `update/3` in this documentation comment - db - shard - doc - doc_write -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
