439 / Документация по конструктору объекта и движений #461
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughДокументация по генерации тестовых данных была значительно обновлена. Включены новые разделы, такие как "Конструктор объекта" и "Конструктор движений документов", с подробными описаниями методов и примерами использования. Также улучшена структура документации, добавлены ссылки и рекомендации по использованию генераторов случайных значений. Внесены изменения в существующие документы для повышения ясности и организации информации. Обновлены комментарии в коде для улучшения понимания параметров функций. Changes
Assessment against linked issues
Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (4)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
SonarQube Quality Gate failed! 
No data Coverage
| @@ -217,7 +217,7 @@ | |||
|
|
|||
| КонецФункции | |||
|
|
|||
| // Создает новый объект. | |||
| // Записывает новый объект, но в отличии от методов см. Записать или см. Провести возвращает конструктор, что позволяет продолжить работу по созданию тестовых данных. | |||
There was a problem hiding this comment.
🔗Длина строки 166 превышает максимально допустимую 150
standard badpractice parameters Why is this an issue?
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (5)
documentation/docs/features/test-data/data-generation/register-records-builder.md (1)
168-168: Исправьте грамматическую ошибку в описании параметраВ описании параметра
ИменаРеквизитовнекорректно использовано сочетание "Массив из Строка".Предлагаемое исправление:
-`ИменаРеквизитов` (Строка или Массив из Строка): Имена реквизитов записи +`ИменаРеквизитов` (Строка или Массив из Строки): Имена реквизитов записи🧰 Tools
🪛 LanguageTool
[uncategorized] ~168-~168: Предлог «из» предполагает употребление существительного в родительном падеже: «из строки» или «Строка»
Context: ... -ИменаРеквизитов(Строка или Массив из Строка): Имена реквизитов записи, разделенные ...(PREP_U_and_Noun)
documentation/docs/features/test-data/data-generation/object-builder.md (1)
28-28: Необходимы небольшие правки форматирования
- Уровень заголовка "Создание нового элемента справочника 'Контрагенты'" должен быть h3 вместо h4
- В описании параметра
ИменаРеквизитовтребуется корректировка падежа: "Массив из Строк"Also applies to: 211-211
🧰 Tools
🪛 Markdownlint (0.35.0)
28-28: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
documentation/docs/features/test-data/data-generation/index.md (3)
144-146: Исправьте дублирование слова "описание"Текущий текст содержит повторение слова "описание". Предлагаю упростить формулировку.
-:::info Полное описание -Описание всех методов и примеры можно посмотреть в [описании конструктора объекта](./object-builder.md) +:::info Подробнее +Все методы и примеры можно посмотреть в [описании конструктора объекта](./object-builder.md)🧰 Tools
🪛 LanguageTool
[duplication] ~144-~144: Возможная опечатка: повтор слова
Context: ...(test-data-deletion.md) :::info Полное описание Описание всех методов и примеры можно посмотреть...(WORD_REPEAT_RULE)
181-183: Исправьте дублирование слова "описание"Аналогичное повторение слова "описание" в блоке info.
-:::info Полное описание -Описание всех методов и примеры можно посмотреть в [описании конструктора движений](./register-records-builder.md) +:::info Подробнее +Все методы и примеры можно посмотреть в [описании конструктора движений](./register-records-builder.md)🧰 Tools
🪛 LanguageTool
[duplication] ~181-~181: Возможная опечатка: повтор слова
Context: ...test-data-deletion.md). :::info Полное описание Описание всех методов и примеры можно посмотреть...(WORD_REPEAT_RULE)
217-217: Добавьте краткое описание возможностей работы с макетамиРекомендуется добавить краткое описание возможностей работы с макетами перед ссылкой на отдельную статью, чтобы читатель понимал, стоит ли переходить по ссылке.
+Макеты позволяют подготовить эталонные наборы данных для тестирования. Они особенно полезны, когда требуется воспроизвести определенные бизнес-сценарии или протестировать граничные случаи. + Работа с макетами описана в отдельной [статье](../load-from-templates.md)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (6)
documentation/docs/features/test-data/data-generation/index.md(3 hunks)documentation/docs/features/test-data/data-generation/object-builder.md(1 hunks)documentation/docs/features/test-data/data-generation/register-records-builder.md(1 hunks)documentation/docs/features/test-data/test-data.md(1 hunks)exts/yaxunit/src/DataProcessors/ЮТКонструкторДвижений/ObjectModule.bsl(3 hunks)exts/yaxunit/src/DataProcessors/ЮТКонструкторТестовыхДанных/ObjectModule.bsl(1 hunks)
🧰 Additional context used
🪛 LanguageTool
documentation/docs/features/test-data/data-generation/index.md
[duplication] ~144-~144: Возможная опечатка: повтор слова
Context: ...(test-data-deletion.md) :::info Полное описание Описание всех методов и примеры можно посмотреть...
(WORD_REPEAT_RULE)
[duplication] ~181-~181: Возможная опечатка: повтор слова
Context: ...test-data-deletion.md). :::info Полное описание Описание всех методов и примеры можно посмотреть...
(WORD_REPEAT_RULE)
documentation/docs/features/test-data/data-generation/object-builder.md
[uncategorized] ~211-~211: Предлог «из» предполагает употребление существительного в родительном падеже: «из строки» или «Строка»
Context: ...* - ИменаРеквизитов (Строка, Массив из Строка): Имена реквизитов объекта или таблично...
(PREP_U_and_Noun)
documentation/docs/features/test-data/data-generation/register-records-builder.md
[uncategorized] ~168-~168: Предлог «из» предполагает употребление существительного в родительном падеже: «из строки» или «Строка»
Context: ... - ИменаРеквизитов (Строка или Массив из Строка): Имена реквизитов записи, разделенные ...
(PREP_U_and_Noun)
🪛 Markdownlint (0.35.0)
documentation/docs/features/test-data/data-generation/object-builder.md
28-28: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time
(MD001, heading-increment)
🔇 Additional comments (6)
documentation/docs/features/test-data/test-data.md (1)
51-51: Корректное обновление ссылки
Обновление ссылки на документацию по генерации данных улучшает навигацию между разделами документации.
documentation/docs/features/test-data/data-generation/register-records-builder.md (1)
1-271: Отличная документация по конструктору движений
Документация хорошо структурирована, содержит понятные примеры использования и подробное описание всех методов конструктора.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~168-~168: Предлог «из» предполагает употребление существительного в родительном падеже: «из строки» или «Строка»
Context: ... - ИменаРеквизитов (Строка или Массив из Строка): Имена реквизитов записи, разделенные ...
(PREP_U_and_Noun)
exts/yaxunit/src/DataProcessors/ЮТКонструкторДвижений/ObjectModule.bsl (1)
50-51: Улучшена документация параметров функций!
Уточнения в описании параметров делают документацию более точной и понятной, явно указывая на работу с реквизитами записи.
Also applies to: 85-85, 110-111
exts/yaxunit/src/DataProcessors/ЮТКонструкторТестовыхДанных/ObjectModule.bsl (1)
Line range hint 220-242: Отличное дополнение к API конструктора!
Метод ДобавитьЗапись удачно расширяет функциональность конструктора:
- Позволяет продолжить работу после записи объекта
- Поддерживает флаг загрузки данных обмена
- Сохраняет консистентность с другими методами класса
documentation/docs/features/test-data/data-generation/object-builder.md (1)
1-493: Отличная документация с подробным описанием API!
Документация хорошо структурирована и содержит:
- Подробное описание всех методов
- Практические примеры использования
- Четкое описание параметров и возвращаемых значений
🧰 Tools
🪛 LanguageTool
[uncategorized] ~211-~211: Предлог «из» предполагает употребление существительного в родительном падеже: «из строки» или «Строка»
Context: ...* - ИменаРеквизитов (Строка, Массив из Строка): Имена реквизитов объекта или таблично...
(PREP_U_and_Noun)
🪛 Markdownlint (0.35.0)
28-28: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time
(MD001, heading-increment)
documentation/docs/features/test-data/data-generation/index.md (1)
Line range hint 1-400: Документация хорошо структурирована и содержательна
Документация предоставляет исчерпывающее описание возможностей генерации тестовых данных с хорошими примерами кода. Структура логична и последовательна.
🧰 Tools
🪛 LanguageTool
[duplication] ~144-~144: Возможная опечатка: повтор слова
Context: ...(test-data-deletion.md) :::info Полное описание Описание всех методов и примеры можно посмотреть...
(WORD_REPEAT_RULE)
alkoleft
force-pushed
the
feature/439
branch
from
a79253d to
5036595
Compare
Описание изменений
Close #439
Summary by CodeRabbit
Новые функции
ДобавитьЗаписьдля записи новых объектов в процессе создания тестовых данных.Исправления ошибок
Документация