From fb59e6372b08375b9e2d85e908b9f672390ab0c5 Mon Sep 17 00:00:00 2001 From: Jorge Caridad <65676916+jcari-dev@users.noreply.github.com> Date: Fri, 12 Jul 2024 13:24:52 -0400 Subject: [PATCH] docs: fix typos in various documentation files (#31656) --- docs/src/release-notes-js.md | 2 +- docs/src/test-api/class-testproject.md | 2 +- docs/src/test-parameterize-js.md | 2 +- docs/src/test-reporters-js.md | 6 +++--- packages/playwright/types/test.d.ts | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/src/release-notes-js.md b/docs/src/release-notes-js.md index 5bcea8962b..18f07daa14 100644 --- a/docs/src/release-notes-js.md +++ b/docs/src/release-notes-js.md @@ -44,7 +44,7 @@ See [the clock guide](./clock.md) for more details. - New CLI option `--fail-on-flaky-tests` that sets exit code to `1` upon any flaky tests. Note that by default, the test runner exits with code `0` when all failed tests recovered upon a retry. With this option, the test run will fail in such case. -- New enviroment variable `PLAYWRIGHT_FORCE_TTY` controls whether built-in `list`, `line` and `dot` reporters assume a live terminal. For example, this could be useful to disable tty behavior when your CI environment does not handle ANSI control sequences well. Alternatively, you can enable tty behavior even when to live terminal is present, if you plan to post-process the output and handle control sequences. +- New environment variable `PLAYWRIGHT_FORCE_TTY` controls whether built-in `list`, `line` and `dot` reporters assume a live terminal. For example, this could be useful to disable tty behavior when your CI environment does not handle ANSI control sequences well. Alternatively, you can enable tty behavior even when to live terminal is present, if you plan to post-process the output and handle control sequences. ```sh # Avoid TTY features that output ANSI control sequences diff --git a/docs/src/test-api/class-testproject.md b/docs/src/test-api/class-testproject.md index 26b8a954d1..5e7c911a65 100644 --- a/docs/src/test-api/class-testproject.md +++ b/docs/src/test-api/class-testproject.md @@ -227,7 +227,7 @@ Use [`property: TestConfig.repeatEach`] to change this option for all projects. * since: v1.45 - type: ?<[boolean]> -Whether to skip entries from `.gitignore` when searching for test files. By default, if neither [`property: TestConfig.testDir`] nor [`property: TestProject.testDir`] are explicitely specified, Playwright will ignore any test files matching `.gitignore` entries. This option allows to override that behavior. +Whether to skip entries from `.gitignore` when searching for test files. By default, if neither [`property: TestConfig.testDir`] nor [`property: TestProject.testDir`] are explicitly specified, Playwright will ignore any test files matching `.gitignore` entries. This option allows to override that behavior. ## property: TestProject.retries * since: v1.10 diff --git a/docs/src/test-parameterize-js.md b/docs/src/test-parameterize-js.md index 8be8009549..7575f96695 100644 --- a/docs/src/test-parameterize-js.md +++ b/docs/src/test-parameterize-js.md @@ -47,7 +47,7 @@ test.afterEach(async ({ page }) => { }); ``` -If you want to have hooks for each test, you can put them inside a `describe()` - so they are executed for each iteration / each invidual test: +If you want to have hooks for each test, you can put them inside a `describe()` - so they are executed for each iteration / each individual test: ```js title="example.spec.ts" [ diff --git a/docs/src/test-reporters-js.md b/docs/src/test-reporters-js.md index bdd7d9d01b..4d07e91ed0 100644 --- a/docs/src/test-reporters-js.md +++ b/docs/src/test-reporters-js.md @@ -102,7 +102,7 @@ List report supports the following configuration options and environment variabl | Environment Variable Name | Reporter Config Option| Description | Default |---|---|---|---| | `PLAYWRIGHT_LIST_PRINT_STEPS` | `printSteps` | Whether to print each step on its own line. | `false` -| `PLAYWRIGHT_FORCE_TTY` | | Whether to produce output suitable for a live terminal. If a number is specifed, it will also be used as the terminal width. | `true` when terminal is in TTY mode, `false` otherwise. +| `PLAYWRIGHT_FORCE_TTY` | | Whether to produce output suitable for a live terminal. If a number is specified, it will also be used as the terminal width. | `true` when terminal is in TTY mode, `false` otherwise. | `FORCE_COLOR` | | Whether to produce colored output. | `true` when terminal is in TTY mode, `false` otherwise. @@ -140,7 +140,7 @@ Line report supports the following configuration options and environment variabl | Environment Variable Name | Reporter Config Option| Description | Default |---|---|---|---| -| `PLAYWRIGHT_FORCE_TTY` | | Whether to produce output suitable for a live terminal. If a number is specifed, it will also be used as the terminal width. | `true` when terminal is in TTY mode, `false` otherwise. +| `PLAYWRIGHT_FORCE_TTY` | | Whether to produce output suitable for a live terminal. If a number is specified, it will also be used as the terminal width. | `true` when terminal is in TTY mode, `false` otherwise. | `FORCE_COLOR` | | Whether to produce colored output. | `true` when terminal is in TTY mode, `false` otherwise. @@ -182,7 +182,7 @@ Dot report supports the following configuration options and environment variable | Environment Variable Name | Reporter Config Option| Description | Default |---|---|---|---| -| `PLAYWRIGHT_FORCE_TTY` | | Whether to produce output suitable for a live terminal. If a number is specifed, it will also be used as the terminal width. | `true` when terminal is in TTY mode, `false` otherwise. +| `PLAYWRIGHT_FORCE_TTY` | | Whether to produce output suitable for a live terminal. If a number is specified, it will also be used as the terminal width. | `true` when terminal is in TTY mode, `false` otherwise. | `FORCE_COLOR` | | Whether to produce colored output. | `true` when terminal is in TTY mode, `false` otherwise. ### HTML reporter diff --git a/packages/playwright/types/test.d.ts b/packages/playwright/types/test.d.ts index b5cc9aec8f..aa8b54049b 100644 --- a/packages/playwright/types/test.d.ts +++ b/packages/playwright/types/test.d.ts @@ -367,7 +367,7 @@ interface TestProject { /** * Whether to skip entries from `.gitignore` when searching for test files. By default, if neither * [testConfig.testDir](https://playwright.dev/docs/api/class-testconfig#test-config-test-dir) nor - * [testProject.testDir](https://playwright.dev/docs/api/class-testproject#test-project-test-dir) are explicitely + * [testProject.testDir](https://playwright.dev/docs/api/class-testproject#test-project-test-dir) are explicitly * specified, Playwright will ignore any test files matching `.gitignore` entries. This option allows to override that * behavior. */