Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Fix broken QUnit.stop link from assert/async and add redirect #1291

Merged
merged 1 commit into from Jun 17, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/Gemfile
Expand Up @@ -21,6 +21,7 @@ gem "minima", "~> 2.0"
# If you have any plugins, put them here!
group :jekyll_plugins do
gem "jekyll-feed", "~> 0.6"
gem "jekyll-redirect-from", "0.13.0"
end

# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
Expand Down
3 changes: 3 additions & 0 deletions docs/Gemfile.lock
Expand Up @@ -19,6 +19,8 @@ GEM
safe_yaml (~> 1.0)
jekyll-feed (0.9.2)
jekyll (~> 3.3)
jekyll-redirect-from (0.13.0)
jekyll (~> 3.3)
jekyll-sass-converter (1.5.0)
sass (~> 3.4)
jekyll-watch (1.5.0)
Expand Down Expand Up @@ -47,6 +49,7 @@ PLATFORMS
DEPENDENCIES
jekyll (= 3.4.3)
jekyll-feed (~> 0.6)
jekyll-redirect-from (= 0.13.0)
minima (~> 2.0)
tzinfo-data

Expand Down
5 changes: 5 additions & 0 deletions docs/_config.yml
Expand Up @@ -7,6 +7,11 @@
## Site settings
## https://jekyllrb.com/docs/configuration/

# Plugins
plugins:
# https://help.github.com/articles/redirects-on-github-pages/
- jekyll-redirect-from

# Conversion
highlighter: rouge
markdown: kramdown
Expand Down
4 changes: 3 additions & 1 deletion docs/assert/async.md
Expand Up @@ -5,6 +5,8 @@ description: Instruct QUnit to wait for an asynchronous operation.
categories:
- assert
- async
redirect_from:
- "/QUnit/stop"
---

## `async( [ acceptCallCount = 1 ] )`
Expand All @@ -19,7 +21,7 @@ Instruct QUnit to wait for an asynchronous operation.

`assert.async()` returns a callback function and pauses test processing until the callback function is invoked the specified number of times. The callback will throw an `Error` if it is invoked more often than the accepted call count.

This replaces functionality previously provided by [`QUnit.stop()`](/QUnit/stop) and [`QUnit.start()`](/QUnit/start).
This replaces functionality previously provided by `QUnit.stop()` and [`QUnit.start()`](/QUnit/start).

### Examples

Expand Down
2 changes: 1 addition & 1 deletion test/main/modules.js
Expand Up @@ -121,7 +121,7 @@ QUnit.test( "keys", function( assert ) {
this.contextTest = true;
} );

QUnit.module( "afterEach and QUnit.stop", {
QUnit.module( "afterEach and assert.async", {
beforeEach: function() {
this.state = false;
},
Expand Down