Skip to content

Commit

Permalink
Fix documentation of Test.force_timeout
Browse files Browse the repository at this point in the history
I couldn't get sphinx-js to work with @name or @function, so it seems
to be easier just to make an actual wrapper function so the docs render correctly.
  • Loading branch information
jgraham committed Nov 23, 2021
1 parent a237be8 commit 3af219c
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions resources/testharness.js
Original file line number Diff line number Diff line change
Expand Up @@ -1127,6 +1127,7 @@

/**
* @deprecated
*
* Register a function as a DOM event listener to the
* given object for the event bubbling phase.
*
Expand Down Expand Up @@ -2826,13 +2827,13 @@
};

/**
* @func
*
* Manually set the test status to ``TIMEOUT``.
*
* Alias for `Test.timeout <#Test.timeout>`_.
*/
Test.prototype.force_timeout = Test.prototype.timeout;
Test.prototype.force_timeout = function() {
return this.timeout();
};

/**
* Mark the test as complete.
Expand Down

0 comments on commit 3af219c

Please sign in to comment.