improve docs

telefonicaid · Aug 2, 2024 · 14cc8d6 · 14cc8d6
1 parent 1b44fe3
commit 14cc8d6
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/lib/services/stats/statsRegistry.js b/lib/services/stats/statsRegistry.js
@@ -271,8 +271,9 @@ function openmetricsHandler(req, res) {
  *
  * @param {String} okCounter          Name of the counter to increment on success.
  * @param {String} errCounter         Name of the counter to increment on error.
- * @param {Function} callback         Callback to wrap. Its first argument is expected
- *                                    to be an error object
+ * @param {Function} callback         Callback to wrap. It must be a function that can
+ *                                    expect any number of parameters, but the first one must
+ *                                    be an indication of the error occured, if any.
  */
 function withStats(okCounter, errCounter, callback) {
     function accounting(...args) {