Skip to content

Commit 3be615a

Browse files
author
rocketraccoon
committed
feat(testplane): fixes
1 parent 21c0731 commit 3be615a

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

docs/html-reporter/html-reporter-setup.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ If you don't want to share analytics with us, you can disable it in any of the f
297297

298298
A callback that is called after every test run. It receives the test result and returns a list of badges.
299299

300-
Usage example: here we set the ticket name and URL, the branch name.
300+
Usage example: here we set the issue name and URL, the branch name.
301301

302302
```typescript title="testplane.config.ts"
303303
{
@@ -349,7 +349,10 @@ describe("badges", () => {
349349
<tr>
350350
<td>`title`</td>
351351
<td>`string`</td>
352-
<td>Required parameter. Displayed badge title.</td>
352+
<td>
353+
Optional parameter. Displayed badge title. If not provided, the badge will not
354+
render.
355+
</td>
353356
</tr>
354357
<tr>
355358
<td>`icon`</td>

i18n/ru/docusaurus-plugin-content-docs/current/html-reporter/html-reporter-setup.mdx

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ import ConfigExamples from "../_partials/html-reporter-config-examples.mdx";
3535
<tr><td>[plugins](#plugins)</td><td>`Plugin[]`</td><td>`[]`</td><td>Список плагинов с их настройками.</td></tr>
3636
<tr><td>[customScripts](#customscripts)</td><td>`AnyFunction[]`</td><td>`[]`</td><td>Список функций, реализующих кастомные скрипты. Например, скрипты Яндекс.Метрики или Жучка.</td></tr>
3737
<tr><td>[yandexMetrika](#yandexmetrika)</td><td>`YandexMetrika`</td><td>*см. ниже*</td><td>[Яндекс.Метрика][yandex-metrika].</td></tr>
38-
<tr><td>[generateBadges](#generatebadges)</td><td>`GenerateBadges`</td><td>`null`</td><td>Колбэк, который вызывается после каждого запуска теста. Он получает результат теста и возвращает список бейджей.</td></tr>
38+
<tr><td>[generateBadges](#generatebadges)</td><td>`GenerateBadges`</td><td>`null`</td><td>Функция, который вызывается после каждого запуска теста. Он получает результат теста и возвращает список бейджей.</td></tr>
3939

4040
</tbody>
4141
</table>
@@ -293,9 +293,9 @@ customScripts: [
293293

294294
<Version version="11.4.0" />
295295

296-
Колбэк, который вызывается после каждого запуска теста. Он получает результат теста и возвращает список бейджей.
296+
Функция, который вызывается после каждого запуска теста. Он получает результат теста и возвращает список бейджей.
297297

298-
Пример использования: здесь мы задаём название тикета и URL, название ветки.
298+
Пример использования: здесь мы задаём имя задачи со ссылкой на неё и название ветки.
299299

300300
```typescript title="testplane.config.ts"
301301
{
@@ -319,7 +319,7 @@ customScripts: [
319319
}
320320
```
321321

322-
Пример как можно установить метаданные в тесте.
322+
Пример установки метаданных в тесте.
323323

324324
```typescript title="testplane.config.ts"
325325
describe("badges", () => {
@@ -347,7 +347,10 @@ describe("badges", () => {
347347
<tr>
348348
<td>`title`</td>
349349
<td>`string`</td>
350-
<td>Обязательный параметр. Отображаемое имя бейджа.</td>
350+
<td>
351+
Опциональный параметр. Отображаемое имя бейджа, но если не передать то бейдж не
352+
будет показываться.
353+
</td>
351354
</tr>
352355
<tr>
353356
<td>`icon`</td>
@@ -357,7 +360,7 @@ describe("badges", () => {
357360
<tr>
358361
<td>`url`</td>
359362
<td>`string`</td>
360-
<td>Опциональный параметр. Ссылка которая откроется при клике на бейдж.</td>
363+
<td>Опциональный параметр. Ссылка, открываемая при нажатии.</td>
361364
</tr>
362365
</tbody>
363366
</table>

0 commit comments

Comments
 (0)