docs: improve consistency of timeout documentation (#2482)

* docs: improve consistency of timeout documentation

* build: disable prettier for md files

* fix: indent

Author: Alex Plischke

docs/web-apps/automated-testing/_partials/_advanced-playwright-cucumber.md

@@ -4,6 +4,7 @@ When using a tunnel with Cucumber for Playwright, you need to explicitly tell Pl
 Its value is stored in the `HTTP_PROXY` env var.
 
 Example:
+
 ```yaml reference
 https://github.com/saucelabs/saucectl-playwright-example/blob/main/examples/cucumber/features/support/steps.js#L5-L17
-```
+```

docs/web-apps/automated-testing/cucumberjs-playwright/advanced.md

@@ -10,7 +10,6 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
 import Advanced, {toc as AdvancedTOC} from '../\_partials/\_advanced.md';
 import AdvancedPlaywrightCucumber, {toc as AdvancedPlaywrightCucumberTOC} from '../\_partials/\_advanced-playwright-cucumber.md';
 
-
 <AdvancedPlaywrightCucumber />
 <Advanced />
 

docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md

@@ -85,7 +85,13 @@ defaults:
 
 <p><small>| OPTIONAL | DURATION |</small></p>
 
-Instructs how long (in `ms`, `s`, `m`, or `h`) `saucectl` should wait for each suite to complete. You can override this setting for individual suites using the `timeout` setting within the [`suites`](#suites) object. If not set, the default value is `0` (unlimited).
+Instructs how long `saucectl` should wait for the suite to complete, overriding the default project timeout setting of 30 minutes.
+
+When the suite reaches the timeout limit, its status is set to '?' in the CLI. This does not reflect the actual status of the job in the Sauce Labs web UI or API.
+
+:::note
+Setting `0` reverts to the value set in `defaults`.
+:::
 
 ```yaml
   timeout: 15m
@@ -805,6 +811,7 @@ suite:
     smartRetry:
       failedOnly: true
 ```
+
 ---
 
 ### `options`

docs/web-apps/automated-testing/cypress/yaml/v1.md

@@ -898,6 +898,7 @@ excludeSpecPattern: ['**/*.*']
 ```
 
 ---
+
 ### `headless`
 
 <p><small>| OPTIONAL | BOOLEAN |</small></p>
@@ -911,6 +912,7 @@ Controls whether or not tests are run in headless mode.
 ```
 
 ---
+
 ### `shard`
 
 <p><small>| OPTIONAL | STRING |</small></p>
@@ -966,7 +968,9 @@ suites:
 
 <p><small>| OPTIONAL | DURATION |</small></p>
 
-Instructs how long `saucectl` should wait for the suite to complete, potentially overriding the default project timeout setting.
+Instructs how long `saucectl` should wait for the suite to complete, overriding the default project timeout setting of 30 minutes.
+
+When the suite reaches the timeout limit, its status is set to '?' in the CLI. This does not reflect the actual status of the job in the Sauce Labs web UI or API.
 
 :::note
 Setting `0` reverts to the value set in `defaults`.

docs/web-apps/automated-testing/playwright/yaml.md

@@ -823,7 +823,6 @@ suites:
       grepInvert: "@slow"
 ```
 
-
 ### `params`
 
 <p><small>| OPTIONAL | OBJECT |</small></p>
@@ -856,6 +855,7 @@ Available browser names: `chromium`, `firefox`, `webkit`, and `chrome`.
 :::
 
 ---
+
 #### `headless`
 
 <p><small>| OPTIONAL | BOOLEAN |</small></p>
@@ -967,7 +967,7 @@ $ mv artifacts/{your-suite-name}/example-test-1-actual.png tests/example.test.js
 
 <p><small>| OPTIONAL | DURATION |</small></p>
 
-Instructs how long `saucectl` should wait for the suite to complete, potentially overriding the default project timeout setting.
+Instructs how long `saucectl` should wait for the suite to complete, overriding the default project timeout setting of 30 minutes.
 
 When the suite reaches the timeout limit, its status is set to '?' in the CLI. This does not reflect the actual status of the job in the Sauce Labs web UI or API.
 

docs/web-apps/automated-testing/replay/yaml.md

@@ -547,7 +547,7 @@ suites:
 
 <p><small>| OPTIONAL | DURATION |</small></p>
 
-Instructs how long `saucectl` should wait for the suite to complete, potentially overriding the default project timeout setting.
+Instructs how long `saucectl` should wait for the suite to complete, overriding the default project timeout setting of 30 minutes.
 
 When the suite reaches the timeout limit, its status is set to '?' in the CLI. This does not reflect the actual status of the job in the Sauce Labs web UI or API.
 

docs/web-apps/automated-testing/testcafe/yaml.md

@@ -734,6 +734,7 @@ Determines whether to run the test suite in headless mode.
 ```yaml
   headless: true
 ```
+
 ---
 
 ### `platformName`
@@ -1003,6 +1004,7 @@ Specifies test compilation settings. The current version of TestCafe can only co
 ---
 
 #### `typescript`
+
 <p><small>| OPTIONAL | OBJECT |</small></p>
 
 Specifies the TypeScript options.
@@ -1262,7 +1264,7 @@ Determines whether to prevent the browser from caching page content. See [TestCa
 
 <p><small>| OPTIONAL | DURATION |</small></p>
 
-Instructs how long `saucectl` should wait for the suite to complete, potentially overriding the default project timeout setting.
+Instructs how long `saucectl` should wait for the suite to complete, overriding the default project timeout setting of 30 minutes.
 
 When the suite reaches the timeout limit, its status is set to '?' in the CLI. This does not reflect the actual status of the job in the Sauce Labs web UI or API.
 

package.json

@@ -14,7 +14,7 @@
     "prepare": "husky install"
   },
   "lint-staged": {
-    "*.{js,jsx,md,css}": [
+    "*.{js,jsx,css}": [
       "npx prettier --check"
     ],
     "*.{js,jsx,ts,tsx}": [