mark Runnable#retries and Runnable#currentRetry methods as public

This change makes it easier for Mocha reporters to report retriable and regular tests differently, should they choose to do so.
mochajs · Jul 8, 2020 · 904609d · 904609d
1 parent 7c8896c
commit 904609d
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/lib/runnable.js b/lib/runnable.js
@@ -165,7 +165,9 @@ Runnable.prototype.isPassed = function() {
 /**
  * Set or get number of retries.
  *
- * @private
+ * @memberof Mocha.Runnable
+ * @public
+ * @returns {number|void}
  */
 Runnable.prototype.retries = function(n) {
   if (!arguments.length) {
@@ -177,7 +179,9 @@ Runnable.prototype.retries = function(n) {
 /**
  * Set or get current retry
  *
- * @private
+ * @memberof Mocha.Runnable
+ * @public
+ * @returns {number|void}
  */
 Runnable.prototype.currentRetry = function(n) {
   if (!arguments.length) {