Add tags docs #107
Merged
Add tags docs #107
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Successfully deployed static |
sonic16x
force-pushed
the
users/rocketraccoon/TESTPLANE-436.tags
branch
from
c353ae4 to
9aee64a
Compare
sonic16x
force-pushed
the
users/rocketraccoon/TESTPLANE-436.tags
branch
from
9aee64a to
09e5757
Compare
KuznetsovRoman
approved these changes
Dec 3, 2025
docs/command-line/index.mdx
Outdated
| -s, --set <set> run tests only in the specified set | ||
| -r, --require <module> require module | ||
| --grep <grep> run only tests matching the pattern | ||
| --tag <tag> run only tests matching the pattern |
Member
There was a problem hiding this comment.
matching the pattern
Maybe "with specified tags"?
docs/command-line/index.mdx
Outdated
| You can assign tags to a test using the `{tag: string | string[]}` parameter. | ||
| You can also add tags dynamically during test execution with the [addTag][add-tag] command, | ||
| but tests tagged this way cannot be filtered at launch. |
Member
There was a problem hiding this comment.
Its unclear, what they cannot be filtered by
Lets write explicitly:
but you cannot use dynamic tags to filter tests at launch
| You can also add tags dynamically during test execution with the [addTag][add-tag] command, | ||
| but tests tagged this way cannot be filtered at launch. | ||
| ```ts |
Member
There was a problem hiding this comment.
Missing example of setting multiple tags in one suite/test
There should be example where tag is array
docs/commands/browser/addTag.mdx
Outdated
| await browser.addTag(["first", "second"]); | ||
| ``` | ||
|
|
||
| Also, the tag object now has the following methods: to add a tag, get a list of tags, and check if a tag exists. |
Member
There was a problem hiding this comment.
following methods: to add a tag
: should be removed
now has methods to add a tag...
docs/commands/browser/addTag.mdx
Outdated
| await browser.addTag(["first", "second"]); | ||
| ``` | ||
|
|
||
| Also, the tag object now has the following methods: to add a tag, get a list of tags, and check if a tag exists. |
Member
There was a problem hiding this comment.
tag object
What is the tag object?
| #### Tag {#testplane-tag} | ||
| Запуск только тестов соответствующих паттерну: |
docs/command-line/index.mdx
Outdated
| ##### Example {#testplane-tag-example} | ||
| You can assign tags to a test using the `{tag: string | string[]}` parameter. |
Member
There was a problem hiding this comment.
Super unclear, what kind of parameter is it
Maybe we should write it like this:
You can assign tags to a test like this:
<example>
| ##### Example {#testplane-tag-example} | ||
| Вы можете назначить теги тесту с помощью параметра `{tag: string | string[]}`. | ||
| Также вы можете добавлять теги динамически во время выполнения теста с помощью команды [assertTag][add-tag], |
| await browser.addTag(["first", "second"]); | ||
| ``` | ||
|
|
||
| Также, объект тега теперь имеет следующие методы: для добавления тега, получения списка тегов и проверки существования тега. |
| <tr> | ||
| <td>tag</td> | ||
| <td>`string | string[]`</td> | ||
| <td>Обязательный параметр. Одна строка или массив строк.</td> |
Member
There was a problem hiding this comment.
Одна строка или массив строк
Зачем явно указывать, что "одна строка"?
Почему не "строка или массив строк"?
Ну и, кажется, тип и так понятен - написан строкой выше. Давай лучше "Название тега или тегов" просто в описании напишем
sonic16x
force-pushed
the
users/rocketraccoon/TESTPLANE-436.tags
branch
from
c2a7374 to
4054e6a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.