Обновление README.md #7
Conversation
Мелкие исправления: запятые, повторы слов, союзы и т.п. Переформулированы некоторые предложения. Добавлен пример.
WalkthroughВ файле README.md были внесены изменения, связанные с улучшением и уточнением документации. Добавлен новый раздел о группировке тестов с помощью аннотации Changes
Possibly related PRs
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
README.md (3)
92-98: Опечатка в слове «конструтор»
Нужен мягкий знак — «конструктор».-...над конструтором сценария. +...над конструктором сценария.
172-175: Нарушено управление падежом в фразе «позволяют разработчиками»
Следует использовать дательный падеж — «разработчикам».-...которые позволяют разработчиками включать или отключать... +...которые позволяют разработчикам включать или отключать...
422-422: Стилистика: «представлять из себя» → «представлять собой»
Фраза «представлять из себя» считается разговорной.-...json должен представлять из себя массив объектов... +...json должен представлять собой массив объектов...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(14 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~306-~306: Прилагательное не согласуется с существительным по роду.
Context: ...ься изолированно и избежать неожиданных побочных эффектор из-за изменяемого состояния тестового н...
(Unify_Adj_NN_gender)
[uncategorized] ~310-~310: Предлог «в» предполагает употребление существительного в винительном или предложном падеже: «экземпляре»
Context: ...я на состояние, хранящееся в переменных экземпляра тестового набора, вам может потребовать...
(PREP_V_and_Noun)
[uncategorized] ~422-~422: Разговорный стиль: «представлять собой».
Context: ...ванного теста. Переданный json должен представлять из себя массив объектов, в каждом из которых кл...
(predstavlat_soboj)
🪛 markdownlint-cli2 (0.17.2)
README.md
458-458: Blank line inside blockquote
(MD028, no-blanks-blockquote)
678-678: Dollar signs used before commands without showing output
(MD014, commands-show-output)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
README.md (6)
92-98: Опечатка в слове «конструктор»В текущей версии допущена опечатка «конструтор». Исправляем на «конструктор».
-... над конструтором сценария. +... над конструктором сценария.
172-174: Согласование падежа: «разработчикам», а не «разработчиками»Правильная форма дательного падежа в данном контексте — «разработчикам».
-...которые позволяют разработчиками включать или отключать... +...которые позволяют разработчикам включать или отключать...
389-389: Наречие «также» пишется слитноКроме того, лишняя запятая перед «как» не нужна.
-...константами так же известными, как пользовательские перечисления. +...константами, также известными как пользовательские перечисления.
403-406: Опечатка «Класный» → «Классный» в названии модуляНазвание модуля и комментарий содержат опечатку.
-// МойКласныйМодуль.os +// МойКлассныйМодуль.os ... -&ИсточникПеречисление("МойКласныйМодуль") +&ИсточникПеречисление("МойКлассныйМодуль")
308-308: Отсутствует запятая после вводного словаПосле «Обратите внимание» необходима запятая.
-Обратите внимание что экземпляр тестового набора... +Обратите внимание, что экземпляр тестового набора...
422-422: Избавиться от разговорного оборота «представлять из себя»Формально-деловой вариант — «представлять собой».
-...json должен представлять из себя массив объектов... +...json должен представлять собой массив объектов...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(14 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~310-~310: Предлог «в» предполагает употребление существительного в винительном или предложном падеже: «экземпляре»
Context: ...я на состояние, хранящееся в переменных экземпляра тестового набора, вам может потребовать...
(PREP_V_and_Noun)
[uncategorized] ~422-~422: Разговорный стиль: «представлять собой».
Context: ...ванного теста. Переданный json должен представлять из себя массив объектов, в каждом из которых кл...
(predstavlat_soboj)
🪛 markdownlint-cli2 (0.17.2)
README.md
458-458: Blank line inside blockquote
(MD028, no-blanks-blockquote)
678-678: Dollar signs used before commands without showing output
(MD014, commands-show-output)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (8)
README.md (8)
100-103: Длинная строка затрудняет чтениеСтрока 102 превышает ~140 символов, из-за чего горизонтальный скролл появляется даже в широких окнах. Рекомендуется разбить предложение на две строки.
243-260: Небольшая опечатка: закрывающая скобкаВ строке 258 пропущена точка с запятой после вызова метода. Хотя это пример BSL, для единообразия лучше добавить
;.-Процедура ТестКоторыйВключенЕслиУсловиеВключенияВернулоИстину() Экспорт +Процедура ТестКоторыйВключенЕслиУсловиеВключенияВернулоИстину() Экспорт;
403-408: Форматирование комментария в примереВ примере модуля (
// МойКлассныйМодуль.os) лишний пустой комментарий-разделитель на 403-ей строке можно убрать — он дробит код без необходимости.
422-423: Исправить разговорную формулировкуФраза «представлять из себя» считается разговорной. Предлагаю заменить на «представлять собой».
-Переданный json должен представлять из себя массив объектов, в каждом из которых ключ это имя параметра, а значение - аргумент. +Переданный JSON должен представлять собой массив объектов, в каждом из которых ключ — это имя параметра, а значение — аргумент.
500-506: Выровнять маркдаун-списокВ блоке консоли после пункта 503 отсутствует пустая строка перед списком, из-за чего рендер может «склеить» текст. Добавьте пустую строку после фразы «сообщаться отдельно».
650-654: Уточнить формулировку про packagedefПредложение на 653-ей строке довольно длинное и содержит два «когда». Рассмотрите упрощение:
-Версии, необходимые для работы, указаны в packagedef, и если вы используете зависимости версий ниже, чем указано, то скорее всего вы получите разнообразные ошибки при запуске тестов. +Необходимые версии перечислены в `packagedef`. Использование более старых версий приведёт к ошибкам при запуске тестов.
657-658: VSCode → VS CodeОфициальное написание редактора — «VS Code».
675-682: Предупреждение markdownlint: MD014По стандарту MD014 после команды с
$желательно показать вывод или убрать символ доллара.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(14 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~310-~310: Предлог «в» предполагает употребление существительного в винительном или предложном падеже: «экземпляре»
Context: ...я на состояние, хранящееся в переменных экземпляра тестового набора, вам может потребовать...
(PREP_V_and_Noun)
[uncategorized] ~422-~422: Разговорный стиль: «представлять собой».
Context: ...ванного теста. Переданный json должен представлять из себя массив объектов, в каждом из которых кл...
(predstavlat_soboj)
🪛 markdownlint-cli2 (0.17.2)
README.md
458-458: Blank line inside blockquote
(MD028, no-blanks-blockquote)
678-678: Dollar signs used before commands without showing output
(MD014, commands-show-output)
🔇 Additional comments (7)
README.md (7)
92-98: Раздел отлично дополняет документациюДобавленное пояснение и пример по
&ТестовыйНаборсущественно повышают понятность жизненного цикла набора. Замечаний нет.
140-143: Логическое уточнение принятоАкцент на том, что экземпляр набора всё равно создаётся, – полезная ремарка. Замечаний нет.
172-175: Хорошее пояснение про множественные условияФормулировка корректна, структура читабельна.
389-397: Пример системного перечисления ясенДокументирование двух сценариев использования делает раздел исчерпывающим.
597-610: Появился плоский режим вывода — 👍Новые пояснения по
--modeподробно раскрывают варианты. Форматирование таблицы опций корректно.
625-644: Опции execute синхронизированыИзменения дублируют опции из discover, что повышает一致ность CLI.
306-310: Исправление опечаток подтверждаю«Эффектов» и «OneUnit» написаны верно; правки корректны.
README.md
Outdated
| КонецПроцедуры | ||
| ``` | ||
|
|
||
| Для того, чтобы объединить тестовые методы сценария в тестовый набор, необходимо разместить аннотацию [`&ТестовыйНабор`](./docs/api/Аннотации/ТестовыйНабор.md) над конструктором сценария. |
There was a problem hiding this comment.
Если тут это описывать, то нужно дополнительно повесить комментарий о том что эта аннотация на самом деле не обязательная, при запуске OneUnit возьмёт все файлы которые передали через -d и/или -f посмотрит есть ли у них конструктор, и если его нет, то он сам зарегистрирует такие файлы как тестовые наборы.
А сама аннотация в целом нужна для управления жизненным циклом, как описано тут: https://github.com/d-hurricane/OneUnit/blob/master/README.md#19-жизненный-цикл-экземпляра-тестового-набора
There was a problem hiding this comment.
Согласен. Когда читал, не хватило примера именно с набором, в дальнейших частях он используется как само собой разумеющееся. Вот и решил закрыть пробел. Попробую дополнить.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
92-94: Опечатка и стилистикаСлово «опеределить» содержит ошибку. Также финальная часть предложения читается тяжеловесно. Предлагаю исправить и упростить формулировку.
-Если по каким-либо причинам потребовалось опеределить конструктор `ПриСозданииОбъекта` сценария, -необходимо дополнить конструктор аннотацией [`&ТестовыйНабор`](./docs/api/Аннотации/ТестовыйНабор.md). В противном случае сценарий не будет зарегистрирован как тестовый набор, -и как следствие не будут обнаружены и тестовые методы данного сценария. +Если по каким-либо причинам потребовалось **определить** конструктор `ПриСозданииОбъекта`, +его нужно отметить аннотацией [`&ТестовыйНабор`](./docs/api/Аннотации/ТестовыйНабор.md). +Иначе сценарий не будет зарегистрирован как тестовый набор, а его тестовые методы не будут обнаружены.
423-427: «Представлять из себя» → «представлять собой»Формулировка «представлять из себя» разговорная; в технической документации лучше использовать «представлять собой».
-Переданный json должен представлять из себя массив объектов, в каждом из которых ключ это имя параметра, а значение - аргумент. +Переданный JSON должен представлять собой массив объектов, в каждом из которых ключ — имя параметра, а значение — аргумент.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(14 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~311-~311: Предлог «в» предполагает употребление существительного в винительном или предложном падеже: «экземпляре»
Context: ...я на состояние, хранящееся в переменных экземпляра тестового набора, вам может потребовать...
(PREP_V_and_Noun)
[uncategorized] ~423-~423: Разговорный стиль: «представлять собой».
Context: ...ванного теста. Переданный json должен представлять из себя массив объектов, в каждом из которых кл...
(predstavlat_soboj)
🪛 markdownlint-cli2 (0.17.2)
README.md
459-459: Blank line inside blockquote
(MD028, no-blanks-blockquote)
679-679: Dollar signs used before commands without showing output
(MD014, commands-show-output)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (3)
92-99: Уточнить пунктуацию и повысить читаемость предложенияВставьте запятые вокруг оборота «как следствие» и удалите лишний союз «и» перед ним — читается легче и соответствует правилам РК:
-..., и как следствие не будут обнаружены и тестовые методы данного сценария. +..., и, как следствие, не будут обнаружены тестовые методы данного сценария.
423-424: Избавиться от разговорного оборота «представлять из себя»Оборот считается разговорным; в технической документации лучше использовать «представлять собой»:
-...json должен представлять из себя массив объектов, в каждом из которых... +...json должен представлять собой массив объектов, в каждом из которых...
458-460: Исправить предупреждение MD028: пустая строка внутри blockquoteПустая строка внутри цитаты нарушает разметку и вызывает предупреждение markdownlint. Удалите строку-разделитель либо добавьте
>перед ней:-> Аргументы передаются в тестовый метод в порядке их следования в списке - -> Лямбда захватывает объект тестового набора, так что ему... +> Аргументы передаются в тестовый метод в порядке их следования в списке +> Лямбда захватывает объект тестового набора, так что ему...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(14 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~311-~311: Предлог «в» предполагает употребление существительного в винительном или предложном падеже: «экземпляре»
Context: ...я на состояние, хранящееся в переменных экземпляра тестового набора, вам может потребовать...
(PREP_V_and_Noun)
[uncategorized] ~423-~423: Разговорный стиль: «представлять собой».
Context: ...ванного теста. Переданный json должен представлять из себя массив объектов, в каждом из которых кл...
(predstavlat_soboj)
🪛 markdownlint-cli2 (0.17.2)
README.md
459-459: Blank line inside blockquote
(MD028, no-blanks-blockquote)
679-679: Dollar signs used before commands without showing output
(MD014, commands-show-output)
🔇 Additional comments (1)
README.md (1)
92-99: Новые пояснения к&ТестовыйНаборвыглядят уместноДобавленное пояснение о необходимости аннотации при наличии конструктора закрывает давний вопрос из предыдущего ревью и улучшает понимание жизненного цикла. Содержимое корректно и не требует доработок.
|
Спасибо! |
Мелкие исправления: запятые, повторы слов, союзы и т.п. Переформулированы некоторые предложения. Добавлен пример.
Summary by CodeRabbit
&ТестовыйНабори приведён пример.