Badges #100
Merged
Badges #100
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
sonic16x
force-pushed
the
origin/users/rocketraccoon/TESTPLANE-630.badges-docs
branch
from
89ee0cf to
aadb276
Compare
✅ Successfully deployed static |
sonic16x
force-pushed
the
origin/users/rocketraccoon/TESTPLANE-630.badges-docs
branch
from
9238d88 to
16d1532
Compare
sonic16x
force-pushed
the
origin/users/rocketraccoon/TESTPLANE-630.badges-docs
branch
from
16d1532 to
618dd93
Compare
KuznetsovRoman
approved these changes
Oct 29, 2025
| <tr><td>[plugins](#plugins)</td><td>`Plugin[]`</td><td>`[]`</td><td>A list of plugins with their settings.</td></tr> | ||
| <tr><td>[customScripts](#customscripts)</td><td>`AnyFunction[]`</td><td>`[]`</td><td>A list of functions that implement custom scripts. For example, Yandex.Metrika scripts or a Bug.</td></tr> | ||
| <tr><td>[yandexMetrika](#yandexmetrika)</td><td>`YandexMetrika`</td><td>*see below*</td><td>[Yandex.Metrika][yandex-metrika].</td></tr> | ||
| <tr><td>[generateBadge](#badgeformatter)</td><td>`BadgeFormatter`</td><td>`null`</td><td>A callback that is called after every test run. It receives the test result and returns a list of badges.</td></tr> |
There was a problem hiding this comment.
Callback is called "generateBadge", but anchor is still "#badgeformatter"
| <tr> | ||
| <td>`url`</td> | ||
| <td>`string`</td> | ||
| <td>Опциональный параметр. Ссылка которая откроется при клике на бейдж.</td> |
There was a problem hiding this comment.
Ссылка которая откроется при клике
Пропущена запятая.
Предлагаю "Ссылка, открываемая при нажатии".
|
|
||
| Колбэк, который вызывается после каждого запуска теста. Он получает результат теста и возвращает список бейджей. | ||
|
|
||
| Пример использования: здесь мы задаём название тикета и URL, название ветки. |
There was a problem hiding this comment.
"тикет" не является общеупотребимым термином, помимо того, что это англицизм, которых лучше избегать в русской документации.
Давай лучше "ключ задачи"
|
|
||
| A callback that is called after every test run. It receives the test result and returns a list of badges. | ||
|
|
||
| Usage example: here we set the ticket name and URL, the branch name. |
There was a problem hiding this comment.
lets not use the word "ticket"
In your title and url you use "issue", which is better. Lets use "issue" here instead of "ticket" for consistency
|
|
||
| <Version version="11.4.0" /> | ||
|
|
||
| Колбэк, который вызывается после каждого запуска теста. Он получает результат теста и возвращает список бейджей. |
| } | ||
| ``` | ||
|
|
||
| Пример как можно установить метаданные в тесте. |
There was a problem hiding this comment.
Не хватает пунктуации между "Пример" и "как".
Чтобы не думать, что тут конкретно нужно вставить, я бы написал "Пример установки метаданных в тесте"
| <tr><td>[plugins](#plugins)</td><td>`Plugin[]`</td><td>`[]`</td><td>Список плагинов с их настройками.</td></tr> | ||
| <tr><td>[customScripts](#customscripts)</td><td>`AnyFunction[]`</td><td>`[]`</td><td>Список функций, реализующих кастомные скрипты. Например, скрипты Яндекс.Метрики или Жучка.</td></tr> | ||
| <tr><td>[yandexMetrika](#yandexmetrika)</td><td>`YandexMetrika`</td><td>*см. ниже*</td><td>[Яндекс.Метрика][yandex-metrika].</td></tr> | ||
| <tr><td>[generateBadge](#badgeformatter)</td><td>`BadgeFormatter`</td><td>`null`</td><td>Колбэк, который вызывается после каждого запуска теста. Он получает результат теста и возвращает список бейджей.</td></tr> |
There was a problem hiding this comment.
В русской документации не принято использовать слово "колбэк". Лучше "функция"
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.
Add docs for badges also small refactoring for version component