From 012472b6ca4488e55235d0e31e0c760364cc07a2 Mon Sep 17 00:00:00 2001 From: Jesse Stuart Date: Sun, 18 Aug 2019 10:14:17 -0400 Subject: [PATCH] fix(docs): Update broken links in docs. (#8847) * fix(docs): Fix broken links pointing to legacy JS file. Signed-off-by: Jesse Stuart * chore(docs): Update CHANGELOG. Signed-off-by: Jesse Stuart * fix(docs): Fix broken link in "Configuration" docs. Signed-off-by: Jesse Stuart --- CHANGELOG.md | 1 + docs/SnapshotTesting.md | 2 +- website/versioned_docs/version-22.x/Configuration.md | 2 +- website/versioned_docs/version-22.x/SnapshotTesting.md | 2 +- website/versioned_docs/version-23.x/Configuration.md | 2 +- website/versioned_docs/version-23.x/SnapshotTesting.md | 2 +- website/versioned_docs/version-24.0/Configuration.md | 2 +- website/versioned_docs/version-24.0/SnapshotTesting.md | 2 +- 8 files changed, 8 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8d40be406241..f88178e8c454 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ - `[jest-fake-timers]` `getTimerCount` will not include cancelled immediates ([#8764](https://github.com/facebook/jest/pull/8764)) ### Chore & Maintenance +- `[docs]` Fix broken link pointing to legacy JS file in "Snapshot Testing". ### Performance diff --git a/docs/SnapshotTesting.md b/docs/SnapshotTesting.md index 8f0d3b0c6be4..22e71d0834c2 100644 --- a/docs/SnapshotTesting.md +++ b/docs/SnapshotTesting.md @@ -291,7 +291,7 @@ Yes, all snapshot files should be committed alongside the modules they are cover ### Does snapshot testing only work with React components? -[React](TutorialReact.md) and [React Native](TutorialReactNative.md) components are a good use case for snapshot testing. However, snapshots can capture any serializable value and should be used anytime the goal is testing whether the output is correct. The Jest repository contains many examples of testing the output of Jest itself, the output of Jest's assertion library as well as log messages from various parts of the Jest codebase. See an example of [snapshotting CLI output](https://github.com/facebook/jest/blob/master/e2e/__tests__/console.test.js) in the Jest repo. +[React](TutorialReact.md) and [React Native](TutorialReactNative.md) components are a good use case for snapshot testing. However, snapshots can capture any serializable value and should be used anytime the goal is testing whether the output is correct. The Jest repository contains many examples of testing the output of Jest itself, the output of Jest's assertion library as well as log messages from various parts of the Jest codebase. See an example of [snapshotting CLI output](https://github.com/facebook/jest/blob/master/e2e/__tests__/console.test.ts) in the Jest repo. ### What's the difference between snapshot testing and visual regression testing? diff --git a/website/versioned_docs/version-22.x/Configuration.md b/website/versioned_docs/version-22.x/Configuration.md index 378c5424c8b9..aa1ec29b43e8 100644 --- a/website/versioned_docs/version-22.x/Configuration.md +++ b/website/versioned_docs/version-22.x/Configuration.md @@ -484,7 +484,7 @@ class MyCustomReporter { } ``` -For the full list of methods and argument types see `Reporter` type in [types/TestRunner.js](https://github.com/facebook/jest/blob/master/types/TestRunner.js) +For the full list of methods and argument types see `Reporter` interface in [packages/jest-reporters/src/types.ts](https://github.com/facebook/jest/blob/master/packages/jest-reporters/src/types.ts) ### `resetMocks` [boolean] diff --git a/website/versioned_docs/version-22.x/SnapshotTesting.md b/website/versioned_docs/version-22.x/SnapshotTesting.md index 8f1d5cda6a87..b1bd3da3ecbb 100644 --- a/website/versioned_docs/version-22.x/SnapshotTesting.md +++ b/website/versioned_docs/version-22.x/SnapshotTesting.md @@ -102,7 +102,7 @@ Yes, all snapshot files should be committed alongside the modules they are cover ### Does snapshot testing only work with React components? -[React](TutorialReacte.md) and [React Native](TutorialReactNative.md) components are a good use case for snapshot testing. However, snapshots can capture any serializable value and should be used anytime the goal is testing whether the output is correct. The Jest repository contains many examples of testing the output of Jest itself, the output of Jest's assertion library as well as log messages from various parts of the Jest codebase. See an example of [snapshotting CLI output](https://github.com/facebook/jest/blob/master/e2e/__tests__/console.test.js) in the Jest repo. +[React](TutorialReacte.md) and [React Native](TutorialReactNative.md) components are a good use case for snapshot testing. However, snapshots can capture any serializable value and should be used anytime the goal is testing whether the output is correct. The Jest repository contains many examples of testing the output of Jest itself, the output of Jest's assertion library as well as log messages from various parts of the Jest codebase. See an example of [snapshotting CLI output](https://github.com/facebook/jest/blob/master/e2e/__tests__/console.test.ts) in the Jest repo. ### What's the difference between snapshot testing and visual regression testing? diff --git a/website/versioned_docs/version-23.x/Configuration.md b/website/versioned_docs/version-23.x/Configuration.md index 37ee38898160..949aab59e96f 100644 --- a/website/versioned_docs/version-23.x/Configuration.md +++ b/website/versioned_docs/version-23.x/Configuration.md @@ -544,7 +544,7 @@ class MyCustomReporter { } ``` -For the full list of methods and argument types see `Reporter` type in [types/TestRunner.js](https://github.com/facebook/jest/blob/master/types/TestRunner.js) +For the full list of methods and argument types see `Reporter` interface in [packages/jest-reporters/src/types.ts](https://github.com/facebook/jest/blob/master/packages/jest-reporters/src/types.ts) ### `resetMocks` [boolean] diff --git a/website/versioned_docs/version-23.x/SnapshotTesting.md b/website/versioned_docs/version-23.x/SnapshotTesting.md index 6dfa070d697c..8121e82e9840 100644 --- a/website/versioned_docs/version-23.x/SnapshotTesting.md +++ b/website/versioned_docs/version-23.x/SnapshotTesting.md @@ -292,7 +292,7 @@ Yes, all snapshot files should be committed alongside the modules they are cover ### Does snapshot testing only work with React components? -[React](TutorialReact.md) and [React Native](TutorialReactNative.md) components are a good use case for snapshot testing. However, snapshots can capture any serializable value and should be used anytime the goal is testing whether the output is correct. The Jest repository contains many examples of testing the output of Jest itself, the output of Jest's assertion library as well as log messages from various parts of the Jest codebase. See an example of [snapshotting CLI output](https://github.com/facebook/jest/blob/master/e2e/__tests__/console.test.js) in the Jest repo. +[React](TutorialReact.md) and [React Native](TutorialReactNative.md) components are a good use case for snapshot testing. However, snapshots can capture any serializable value and should be used anytime the goal is testing whether the output is correct. The Jest repository contains many examples of testing the output of Jest itself, the output of Jest's assertion library as well as log messages from various parts of the Jest codebase. See an example of [snapshotting CLI output](https://github.com/facebook/jest/blob/master/e2e/__tests__/console.test.ts) in the Jest repo. ### What's the difference between snapshot testing and visual regression testing? diff --git a/website/versioned_docs/version-24.0/Configuration.md b/website/versioned_docs/version-24.0/Configuration.md index bfe463a13585..9a1727bf45a3 100644 --- a/website/versioned_docs/version-24.0/Configuration.md +++ b/website/versioned_docs/version-24.0/Configuration.md @@ -618,7 +618,7 @@ class MyCustomReporter { } ``` -For the full list of methods and argument types see `Reporter` type in [types/TestRunner.js](https://github.com/facebook/jest/blob/master/types/TestRunner.js) +For the full list of methods and argument types see `Reporter` interface in [packages/jest-reporters/src/types.ts](https://github.com/facebook/jest/blob/master/packages/jest-reporters/src/types.ts) ### `resetMocks` [boolean] diff --git a/website/versioned_docs/version-24.0/SnapshotTesting.md b/website/versioned_docs/version-24.0/SnapshotTesting.md index 072efda901b8..59c5ea9aa3b6 100644 --- a/website/versioned_docs/version-24.0/SnapshotTesting.md +++ b/website/versioned_docs/version-24.0/SnapshotTesting.md @@ -292,7 +292,7 @@ Yes, all snapshot files should be committed alongside the modules they are cover ### Does snapshot testing only work with React components? -[React](TutorialReact.md) and [React Native](TutorialReactNative.md) components are a good use case for snapshot testing. However, snapshots can capture any serializable value and should be used anytime the goal is testing whether the output is correct. The Jest repository contains many examples of testing the output of Jest itself, the output of Jest's assertion library as well as log messages from various parts of the Jest codebase. See an example of [snapshotting CLI output](https://github.com/facebook/jest/blob/master/e2e/__tests__/console.test.js) in the Jest repo. +[React](TutorialReact.md) and [React Native](TutorialReactNative.md) components are a good use case for snapshot testing. However, snapshots can capture any serializable value and should be used anytime the goal is testing whether the output is correct. The Jest repository contains many examples of testing the output of Jest itself, the output of Jest's assertion library as well as log messages from various parts of the Jest codebase. See an example of [snapshotting CLI output](https://github.com/facebook/jest/blob/master/e2e/__tests__/console.test.ts) in the Jest repo. ### What's the difference between snapshot testing and visual regression testing?