Skip to content

Commit

Permalink
docs: add passive option disclaimer (#48)
Browse files Browse the repository at this point in the history
  • Loading branch information
shadowusr authored Dec 20, 2024
1 parent d655633 commit 8d01913
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
9 changes: 6 additions & 3 deletions docs/config/browsers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,8 @@ If the value is not set, the general timeout for all browsers, set with the [sys
<td>`false`</td>
<td>
Allows making the browser passive. In passive browsers, tests do not run by default.
_Available since [email protected]_.
_Available since [email protected]_. **Warning**: it currently has issues, read
below.
</td>
</tr>
<tr>
Expand Down Expand Up @@ -467,8 +468,10 @@ This option guarantees strict order of reading tests. Default: `false`.
### passive {#passive}

<Admonition type="warning">
Available since [email protected]. Does not work with the deprecated plugin
[hermione-passive-browsers](https://github.com/gemini-testing/testplane-passive-browsers).
Available since [email protected].

This option currently doesn't work well with html-reporter. For now, we recommend to keep using the [hermione-passive-browsers](https://github.com/gemini-testing/testplane-passive-browsers) plugin. Note that the plugin and this option must not be used together. We're already working on a fix.

</Admonition>

Allows making the browser passive. In passive browsers, tests do not run by default. Using the helper [`testplane.also.in`][testplane-also-in-helper], you can enable a test or suite before it is run.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ const browserOptions = {
<td>`false`</td>
<td>
Позволяет сделать браузер пассивным. В пассивных браузерах тесты не запускаются по
умолчанию. _Доступна с [email protected]_.
умолчанию. _Доступна с [email protected]_. **Внимание**: есть ограничения, см. ниже.
</td>
</tr>
<tr>
Expand Down Expand Up @@ -470,8 +470,10 @@ interface FailedTestData {
### passive {#passive}

<Admonition type="warning">
Доступна с [email protected]. Не работает вместе с устаревшим плагином
[hermione-passive-browsers](https://github.com/gemini-testing/testplane-passive-browsers).
Доступна с [email protected].

В данный момент эта опция не работает с html-reporter. В данный момент мы рекомендуем продолжить использовать плагин [hermione-passive-browsers](https://github.com/gemini-testing/testplane-passive-browsers). Обратите внимание, что нельзя использовать плагин и эту опцию одновременно. Мы уже работаем над исправлением проблемы.

</Admonition>

Позволяет сделать браузер пассивным. В пассивных браузерах тесты не запускаются по умолчанию. С помощью хелпера [`testplane.also.in`][testplane-also-in-helper] можно включить тест или сьют, перед которым он указан.
Expand Down

0 comments on commit 8d01913

Please sign in to comment.