Skip to content

Commit 939f29f

Browse files
gitKrystanchriskrycho
authored andcommittedDec 15, 2022
Generate documentation
(cherry picked from commit ff8bda7) # Conflicts: # package.json
1 parent 95285cc commit 939f29f

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed
 

‎API.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ keyboard.
311311

312312
#### Parameters
313313

314-
* `options` **[Object][72]?** optional tab behaviors
314+
* `options` **[Object][72]?** optional tab behaviors (optional, default `{}`)
315315

316316
* `options.backwards` **[boolean][71]** indicates if the the user navigates backwards (optional, default `false`)
317317
* `options.unRestrainTabIndex` **[boolean][71]** indicates if tabbing should throw an error when tabindex is greater than 0 (optional, default `false`)
@@ -891,7 +891,7 @@ Sets up the basic framework used by application tests.
891891

892892
* `context` **[Object][72]** the context to setup
893893

894-
Returns **[Promise][66]<[Object][72]>** resolves with the context that was setup
894+
Returns **[Promise][66]\<void>** resolves when the context is set up
895895

896896
### validateErrorHandler
897897

@@ -1018,7 +1018,7 @@ Returns deprecations which have occured so far for a the current test context
10181018

10191019
### Parameters
10201020

1021-
* `callback` **CallableFunction?** The callback that when executed will have its DeprecationFailure recorded
1021+
* `callback` **[Function][79]?** The callback that when executed will have its DeprecationFailure recorded
10221022

10231023
### Examples
10241024

@@ -1076,7 +1076,7 @@ Returns warnings which have occured so far for a the current test context
10761076

10771077
### Parameters
10781078

1079-
* `callback` **CallableFunction?** The callback that when executed will have its warnings recorded
1079+
* `callback` **[Function][79]?** The callback that when executed will have its warnings recorded
10801080

10811081
### Examples
10821082

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
"prepack": "yarn build",
3030
"postpack": "rimraf addon-test-support/**/*.js public-types",
3131
"clean": "git clean -x -f",
32-
"docs": "documentation build --document-exported \"addon-test-support/@ember/test-helpers/index.js\" --config documentation.yml --markdown-toc-max-depth 3 -f md -o API.md",
32+
"docs": "yarn build && documentation build --document-exported \"addon-test-support/@ember/test-helpers/index.js\" --config documentation.yml --markdown-toc-max-depth 3 -f md -o API.md",
3333
"lint": "npm-run-all lint:*",
3434
"lint:js": "eslint --cache .",
3535
"lint:ts": "tsc --noEmit && tsc --noEmit --project type-tests",

0 commit comments

Comments
 (0)
Please sign in to comment.