Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add passive option disclaimer #48

Merged
merged 1 commit into from
Dec 20, 2024
Merged

docs: add passive option disclaimer #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/config/browsers.mdx
View file
Open in desktop
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
8 changes: 5 additions & 3 deletions i18n/ru/docusaurus-plugin-content-docs/current/config/browsers.mdx
View file
Open in desktop
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
Loading