Commit Graph

26 Commits

Author SHA1 Message Date
Tom Mrazauskas bf02c8765c
docs: use admonition in Testing Asynchronous Code page (#13284) 2022-09-23 09:18:53 +02:00
Aditya Agarwal fe5f37038c
Rework the docs for "Testing Asynchronous Code" (#12555) 2022-04-11 09:50:50 +02:00
Joe Previte e233b91632
docs(TestingAsyncCode.md): add note about not mixing done w/promises (#11077) 2022-02-15 21:50:03 +01:00
Greg 4810f74a1c
Fixing minor typo in the example code where the example should be using ToMatch not ToThrow (#11205) 2021-03-17 11:05:19 +01:00
Mahfoudh Arous 28413dfd99
fixing few typos and enhancing clarity in few sentences, in docs (#10296) 2020-07-23 07:39:43 +02:00
Josh Justice 677b763ec0
docs: Grammatical Corrections to Async Docs Page (#9679) 2020-03-25 21:46:22 +01:00
mkoliba 0a958e8e62 docs: clarify error handling when using test callbacks (#9365) 2020-01-27 20:56:08 +01:00
Carolyn Stransky 59f6e3fd3f Docs: Removed condescending language (#9040)
* Round 1 - simply, just

* Round 2 - easy, easily, of course, simple
2019-10-11 15:53:50 +09:00
VitBu c8d8cf03ce redundant and confusing line (#8417)
expect.assertions relevant only for tests expected to fail.
after locating this I also found a post about it in stackoverflow:
https://stackoverflow.com/questions/54706481/expect-assertions-in-async-await-function
So it seems to confuse many people.
2019-06-03 14:11:44 +01:00
hiredgunhouse 50de6ec88c Update TestingAsyncCode.md (#7478) 2018-12-24 14:00:15 +01:00
Flavien Pensato 24880d9e9b removed useless expect.assertions (#7131)
* removed useless expect.assertions

In a lot of case `expect.assertions(1);` is no need. It can be confusing.

* add changelog + some missing case I forgot
2018-10-13 10:26:00 -04:00
Pavel Chertorogov a5cdea2be9 docs: fix `rejects.toMatch` on `rejects.toThrow` (#6999) 2018-09-19 14:01:21 +02:00
Ika 3d4f0db0e4 docs: adjust heading level to enable navigation (#6539)
* docs: adjust heading level

* docs: adjust heading level for versioned docs
2018-06-28 08:53:24 +01:00
Simen Bekkhus 6eeadab63b stop wrapping markdown (#6299) 2018-05-27 01:16:17 +01:00
Rick Hanlon II 5bd6ee166a Backfill 22.x docs (#5822) 2018-03-27 16:06:31 +01:00
Simen Bekkhus 9b40311dec Format markdown files with Prettier (#4853)
* Format md files with prettier

* Format even more markdown

* Fix escaping of .

* Don't use prettier on readme.md

* Use prettier@1.8.1

* Prettify moar files

* Remove redundant prettier options from vscode settings

* Format with prettier 1.8.2
2017-11-10 19:33:02 +00:00
Eric Nakagawa 172c0b28d5 Update website to use Docusaurus (#4536)
* Adding a clean copy of Docusaurus

Updating sidebar

Modifying files into Docusaurus format

Slight header logo CSS change

Ignore translated files and build directory

Proper file locations for Docusaurus

Move blog files to Docusaurus preferred location, modified crowdin to output /docs to /translated_pages, updated siteConfig.js

Eslinting Docusaurus files

Ignoring website/blog pages

Linter fixes

* Updating Circle config to remove website test

* Updating Circle config to auto-deploy website

* Add @deltice's config changes before website build, skip yarn build step

* Switch crowdin branch to master

* Updating siteconfig to @deltice's file

* Test crowdin branch

* Switching Crowdin to master

* Uses yarn to install, run, and deploy

* Feedback fixes

Switch to use process.env.VAR for algolia key

Switching crowdin upload/download to use yarn

Circle CI fix

Adding a delay to crowdin

Fixing prettier errors

Updating crowdin command in circle ci config

Path fix

* Upgrading docusaurus to 1.0.0a40, adds an RSS/Atom feed

* Update Docusaurus version

* Updated footer to reflect current footer. Updated footer logo.

* Fixes Edit this doc link, removes node_modules from .gitignore

* Move .gitignore rules to top level

* Updating license file in siteConfig to MIT, added new Docusaurus beta to package.json

* Lint fix

* Editing siteConfig.js to account for /docs not living in /docs/en
2017-10-11 09:00:06 +01:00
Eric Nakagawa 62d29f2636 Add Localization Support for Jest Website (#3416)
* Adds a link to CrowdIn project from language drop down

* Adds comments to generated files

* Modify Circle CI to manually download crowdin cli

* Doc build process only renders pages that are enabled in languages.js

* Added a favicon.ico

* Merging TutorialAsync.md

Adding Bosnian, enabling Espanol

Using ENV variables
2017-05-02 21:33:30 +01:00
Robin Pokorný 5749d38e06 Update promise docs (#3201)
* Update docs on promises

* Remove promises from `expect.assertions` and `test`

* Keep docs for promise return

* Update async docs

* Update the async tutorial

* Nicer headlines in Testing Async code

* Update TestingAsyncCode.md

* Update TutorialAsync.md
2017-05-02 13:56:02 +01:00
Eric Nakagawa 27b53ca4fe Revert Localization effort (#3404)
* Revert Localization effort

* Reran prettier

* Revert dangerfile.js

* Reverting README.md

* Moving line alphabetical order
2017-04-27 21:40:58 -07:00
Eric Nakagawa 144327dc59 Add Localization Support for Jest Website (#3337)
* Merging TutorialAsync.md

* Copied all docs from current master branch

Localization Cleanup

Added a link to CrowdIn in language drop down

Further cleanup, moved CrowdIn API key to environment

HeaderNav fix

* Fixes prettier.js and other CI issues
Added comments to generated files
Worked out additional lint issues, added i18n files to ignore

* Update .eslintignore
2017-04-25 18:02:29 +01:00
Rogelio Guzman b5d9ed899b Add back docs for the old way of testing promises (#3256)
* Add back docs for the old way of testing promises

Fixes #3250

* Add `return` note to old version
2017-04-05 11:21:16 -07:00
Simon Adcock b87fb0dcf1 clarify that resolves introduced in v20 (#3245) 2017-04-03 13:56:56 -07:00
Dirk-Jan Rutten 74bb34d5c3 Updated expect API docs with .resolves and .rejects (#3172)
* Updated expect API docs with .resolves and .rejects

* Fixed linter errors in the docs.

* added API availability status

* minor styling issue fix
2017-03-21 14:19:29 -07:00
Hannan Ali 5ab8e2826e ESLint support for documentation (#3047)
* add markdown plugin in eslint

* add lint-docs build step

* lint JavaScript file

* final lint-docs command

* lint ExpectAPI

* lint GettingStarted.md

* lint GlobalAPI

* lint GlobalAPI

* lint JestObjectAPI

* lint Webpack.md

* lint UsingMatchers.md in docs

* lint TutorialReactNative.md in docs

* lint TutorialReact.md in docs

* lint docs file

* add lint-docs to test-ci script

* add lint-docs script to test & test-ci

* turn off more rules to lint-docs in package.json

* remove lint-docs from test and test-ci

* add lint-docs to test script in package.json

* remove lint-docs script from circle.yml

* add lint-docs script to test-ci in package.json

* rename js codeblock with json appropriately

* remove unnecessary log files

* remove lint-docs from test-ci

test script already includes lint-docs,
it'll be reduntant to do the same for more than one node versions

* remove error.log file

* use eslintrc-docs.json for overriding

* remove eslint comments from docs

Removing eslint comments from docs and moving them to
top level in .eslintrc-docs.json

* add lint-docs in correct order to test-ci and test
2017-03-04 08:46:48 +00:00
Héctor Ramos 27a8077258 Revamped Jest Docs and Website
New look and feel. Updated all tutorials, docs, guides with latest best practices.

* Cleaned up API Reference docs (#2422)
* Reorganized Sidebar Navigation
* New Introduction Section (#2425)
* Simplified Getting Started introduction
* Break up API Reference into multiple docs, separate from Guides (#2388)
* Support is now Help (#2370)
* Add "Snapshot Testing", "Testing Asynchronous Code" & "Setup and Teardown" docs (#2419, #2406)
* Create Jest user showcase (#2369)
* New blog post announcing refreshed documentation (#2522)
* Truncate blog posts in blog index
* New homepage hero (#2662)
* New mobile nav (#2664)
* Add standard FB Open Source Footer (#2660)
* Add RedirectLayout to prevent broken links (#2700)
* Refreshed Homepage and Colors across site (#2699)
* Deploy Jest website via CircleCI
2017-01-27 09:40:05 -08:00