Добавить в заголовки сущности #129
Conversation
WalkthroughВнесены правки в документацию продуктового фреймворка: обновлены заголовки и основные разделы для явного указания используемых аннотаций и терминов (например, &Желудь, &Пластилин, &Верховный и др.), добавлены или скорректированы примеры кода, а также исправлены незначительные опечатки и форматирование. Изменения не затрагивают экспортируемые сущности. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 минуты Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
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 (12)
docs/product/framework-elements/150-component-uniqueness.md (1)
2-5: Добавление аннотации в заголовок может разорвать существующие якоря и внешние ссылкиСлайдающие генераторы (VuePress, Docusaurus и др.) формируют идентификатор заголовка из текста. При изменении
#-заголовка с
Уникальность экземпляров компонентов→Уникальность экземпляров компонентов (&Характер)меняется и slug, что ломает:• внешние ссылки на этот раздел;
• автосгенерированные оглавления других страниц;
• закладки пользователей.Проверьте, нет ли 404 в построенном сайте. При необходимости сохраните старый идентификатор, задав явный anchor:
# Уникальность экземпляров компонентов (&Характер) {#component-uniqueness}docs/product/framework-elements/060-app-settings-injection.md (1)
2-5: Проверьте сохранность ссылок после изменения заголовкаАналогично предыдущему файлу: добавление суффикса
(&Деталька, autumn-properties)изменит slug раздела и может привести к битым ссылкам. Если раздел уже упоминался во внешних материалах, зафиксируйте старый идентификатор через пользовательский anchor:# Внедрение настроек приложения (&Деталька, autumn-properties) {#app-settings-injection}docs/product/framework-elements/110-components-sorting.md (1)
2-5: Суффикс&Порядокменяет slug — убедитесь, что TOC остаётся валиднымИз-за изменения текста первого-уровня заголовка может «поехать» оглавление и внутренние ссылки типа
(#упорядочивание-компонентов…). Добавьте фиксированный id или проверьте все вхождения:# Упорядочивание компонентов… (&Порядок) {#components-sorting-order}docs/product/framework-elements/130-component-overriding.md (1)
2-5: Новый заголовок с(&Верховный)требует проверки обратной совместимости ссылокПовторяется та же история со slug-ами. Рекомендуется:
- Прогнать линтер ссылок/HTML-валидатор на собранной документации.
- При необходимости закрепить прежний id.
# Переопределение компонента по имени (&Верховный) {#component-overriding}docs/product/framework-elements/040-components-factory.md (1)
2-5: Несоответствие между title и H1В
front-matterаннотации(&Дуб, &Завязь)уже добавлены, однако сам H1-заголовок (Line 5) остался старым. Для визуальной и структурной единообразности предложите тот же суффикс и в основной заголовок.-# Фабрика компонентов +# Фабрика компонентов (&Дуб, &Завязь)docs/product/framework-elements/190-launch-control-inversion.md (1)
2-2: Обрамите значениеtitleкавычками для корректного YAML-парсингаВ YAML-фронтматтере спец-символ
&и скобки могут трактоваться парсером как сигилы. Рекомендуется заключать строку целиком в двойные кавычки; тогда риск некорректного разбора метаданных будет нулевой. Аналогичную правку стоит сделать и в других изменённых файлах.-title: Инверсия управления запуском приложения (&Рогатка) +title: "Инверсия управления запуском приложения (&Рогатка)"Also applies to: 5-5
docs/product/framework-elements/070-custom-arguments.md (1)
2-2: Кавычки в YAML-фронтматтере помогут избежать побочных эффектовЧтобы символ
&в названии не был интерпретирован как ссылка, обрамите значениеtitleв кавычки.-title: Произвольные аргументы конструктора (&Блестяшка) +title: "Произвольные аргументы конструктора (&Блестяшка)"Also applies to: 5-5
docs/product/framework-elements/090-aliases.md (1)
2-2: Добавьте кавычки вокруг значенияtitleЭто убережёт фронтматтер от возможных проблем с символом
&и скобками.-title: Алиасы компонентов (&Прозвище) +title: "Алиасы компонентов (&Прозвище)"Also applies to: 5-5
docs/product/framework-elements/180-conditional-registration.md (1)
2-2: Предлагаю заключить строкуtitleв кавычкиКонсистентность и устойчивость YAML перед спец-символами.
-title: Условная регистрация компонентов в контексте приложения (&Заготовка) +title: "Условная регистрация компонентов в контексте приложения (&Заготовка)"Also applies to: 5-5
docs/product/framework-elements/080-instance-generator.md (1)
2-2: Нитпик: экранирование строкиtitleДля единообразия и надёжного парсинга оберните значение в кавычки.
-title: Генератор экземпляров компонентов (&Табакерка) +title: "Генератор экземпляров компонентов (&Табакерка)"Also applies to: 5-5
docs/product/framework-elements/100-aliases-grouping.md (1)
82-82: Снижайте громоздкость предложенияФраза содержит два придаточных подряд («…метода, один который…, а второй который…»). Рекомендуется разделить:
«…два метода: первый получает на вход панка и его описание, второй — возвращает собранную банду.»docs/product/framework-elements/010-component-declaration.md (1)
19-23: Уточните назначение процедурыЧтоНибудьПроверитьЕё тело заменено комментарием-заглушкой. Чтобы пример не выглядел «сломано», лучше либо:
Процедура ЧтоНибудьПроверить() // … полезная бизнес-логика … КонецПроцедурылибо убрать вовсе.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (19)
docs/product/framework-elements/010-component-declaration.md(2 hunks)docs/product/framework-elements/020-component-instance.md(1 hunks)docs/product/framework-elements/030-components-binding.md(1 hunks)docs/product/framework-elements/040-components-factory.md(1 hunks)docs/product/framework-elements/050-dependency-injection.md(2 hunks)docs/product/framework-elements/060-app-settings-injection.md(1 hunks)docs/product/framework-elements/070-custom-arguments.md(1 hunks)docs/product/framework-elements/080-instance-generator.md(1 hunks)docs/product/framework-elements/090-aliases.md(1 hunks)docs/product/framework-elements/100-aliases-grouping.md(2 hunks)docs/product/framework-elements/110-components-sorting.md(1 hunks)docs/product/framework-elements/120-components-prioritization.md(2 hunks)docs/product/framework-elements/130-component-overriding.md(1 hunks)docs/product/framework-elements/140-component-post-initialization.md(1 hunks)docs/product/framework-elements/150-component-uniqueness.md(1 hunks)docs/product/framework-elements/160-additional-processing.md(1 hunks)docs/product/framework-elements/180-conditional-registration.md(1 hunks)docs/product/framework-elements/190-launch-control-inversion.md(1 hunks)docs/product/getting-started/20-first-steps.md(1 hunks)
🧰 Additional context used
🧠 Learnings (8)
📓 Common learnings
Learnt from: nixel2007
PR: autumn-library/autumn#87
File: :0-0
Timestamp: 2024-07-27T04:01:18.090Z
Learning: ФабрикаЖелудей является внутренним классом и не должна быть отражена в информации об обновлении.
Learnt from: nixel2007
PR: autumn-library/autumn#89
File: src/internal/Классы/АннотацияНапильник.os:6-27
Timestamp: 2024-07-27T04:01:18.090Z
Learning: Прозвища в функции `МожетПрименятьсяНа` теперь всегда включают имя жёлудя, что исключает необходимость явного добавления имени жёлудя в список идентификаторов для проверки.
📚 Learning: фабрикажелудей является внутренним классом и не должна быть отражена в информации об обновлении....
Learnt from: nixel2007
PR: autumn-library/autumn#87
File: :0-0
Timestamp: 2024-07-27T04:01:18.090Z
Learning: ФабрикаЖелудей является внутренним классом и не должна быть отражена в информации об обновлении.
Applied to files:
docs/product/framework-elements/020-component-instance.mddocs/product/framework-elements/040-components-factory.mddocs/product/getting-started/20-first-steps.mddocs/product/framework-elements/010-component-declaration.md
📚 Learning: the method `добавитьзавязьизлямбды` is located in `фабрикажелудей` and should not be included in the...
Learnt from: nixel2007
PR: autumn-library/autumn#87
File: :0-0
Timestamp: 2024-07-27T04:01:18.090Z
Learning: The method `ДобавитьЗавязьИзЛямбды` is located in `ФабрикаЖелудей` and should not be included in the change log.
Applied to files:
docs/product/framework-elements/020-component-instance.mddocs/product/framework-elements/030-components-binding.mddocs/product/framework-elements/160-additional-processing.mddocs/product/framework-elements/190-launch-control-inversion.mddocs/product/framework-elements/040-components-factory.mddocs/product/getting-started/20-first-steps.mddocs/product/framework-elements/080-instance-generator.mddocs/product/framework-elements/010-component-declaration.mddocs/product/framework-elements/050-dependency-injection.md
📚 Learning: при объявлении аннотации, процедура `присозданииобъекта` не должна быть помечена как `экспорт`. это ...
Learnt from: nixel2007
PR: autumn-library/autumn#109
File: src/internal/Классы/АннотацияФинальныйШтрих.os:10-13
Timestamp: 2024-11-14T18:36:04.275Z
Learning: При объявлении аннотации, процедура `ПриСозданииОбъекта` не должна быть помечена как `Экспорт`. Это требуется только при использовании аннотации, а не при её объявлении.
Applied to files:
docs/product/framework-elements/030-components-binding.mddocs/product/framework-elements/070-custom-arguments.mddocs/product/framework-elements/080-instance-generator.mddocs/product/framework-elements/010-component-declaration.mddocs/product/framework-elements/140-component-post-initialization.md
📚 Learning: the method `добавитьзавязь` in `поделка.os` utilizes lambdas to enhance its functionality, making it...
Learnt from: nixel2007
PR: autumn-library/autumn#87
File: :0-0
Timestamp: 2024-07-27T04:01:18.090Z
Learning: The method `ДобавитьЗавязь` in `Поделка.os` utilizes lambdas to enhance its functionality, making it more flexible and powerful.
Applied to files:
docs/product/framework-elements/030-components-binding.mddocs/product/framework-elements/160-additional-processing.mddocs/product/framework-elements/040-components-factory.mddocs/product/framework-elements/070-custom-arguments.mddocs/product/framework-elements/180-conditional-registration.mddocs/product/framework-elements/080-instance-generator.mddocs/product/framework-elements/050-dependency-injection.md
📚 Learning: прозвища в функции `можетприменятьсяна` теперь всегда включают имя жёлудя, что исключает необходимос...
Learnt from: nixel2007
PR: autumn-library/autumn#89
File: src/internal/Классы/АннотацияНапильник.os:6-27
Timestamp: 2024-07-27T04:01:18.090Z
Learning: Прозвища в функции `МожетПрименятьсяНа` теперь всегда включают имя жёлудя, что исключает необходимость явного добавления имени жёлудя в список идентификаторов для проверки.
Applied to files:
docs/product/framework-elements/160-additional-processing.mddocs/product/framework-elements/150-component-uniqueness.mddocs/product/getting-started/20-first-steps.mddocs/product/framework-elements/070-custom-arguments.mddocs/product/framework-elements/090-aliases.mddocs/product/framework-elements/010-component-declaration.mddocs/product/framework-elements/050-dependency-injection.md
📚 Learning: пустое тело процедуры `присозданииобъекта`, служащей конструктором класса, является обычной практико...
Learnt from: nixel2007
PR: autumn-library/autumn#89
File: tests/ТестКлассы/Классы/ЖелудьСОтключеннымиНапильниками.os:14-20
Timestamp: 2024-07-27T04:01:18.090Z
Learning: Пустое тело процедуры `ПриСозданииОбъекта`, служащей конструктором класса, является обычной практикой для проектов на ОСени (1C:Enterprise). Аннотации часто применяются к конструктору.
Applied to files:
docs/product/getting-started/20-first-steps.mddocs/product/framework-elements/070-custom-arguments.mddocs/product/framework-elements/080-instance-generator.mddocs/product/framework-elements/010-component-declaration.mddocs/product/framework-elements/050-dependency-injection.mddocs/product/framework-elements/140-component-post-initialization.md
📚 Learning: валидация значений параметра `значение` для аннотации `порядок` выполняется в классе `фабрикажелудей...
Learnt from: nixel2007
PR: autumn-library/autumn#109
File: src/internal/Классы/АннотацияПорядок.os:12-23
Timestamp: 2024-11-14T18:41:13.766Z
Learning: Валидация значений параметра `Значение` для аннотации `Порядок` выполняется в классе `ФабрикаЖелудей`.
Applied to files:
docs/product/framework-elements/110-components-sorting.mddocs/product/framework-elements/050-dependency-injection.md
🪛 LanguageTool
docs/product/framework-elements/100-aliases-grouping.md
[uncategorized] ~82-~82: Избыточные определения. В правильно составленном предложении не должно быть больше одного придаточного определения.
Context: ...вой уникальный СобирательПанков.os, в котором нужно определить два метода, один который получает на входе панка и его описание,...
(OPREDELENIA)
🔇 Additional comments (10)
docs/product/framework-elements/140-component-post-initialization.md (1)
2-7: Изменения принимаютсяПравки заголовка и лёгкая корректировка вопросительной формы не затрагивают ссылки (если раздел был новым) и улучшают читаемость. Замечаний нет.
docs/product/framework-elements/120-components-prioritization.md (1)
2-5: Заголовок и front-matter синхронизированы — так держатьАннотация
(&Верховный)теперь явно отражена и в метаданных, и в H1-заголовке; это повышает «сканируемость» оглавления и соответствует принятому стилю остальных файлов. Замечаний нет.docs/product/framework-elements/020-component-instance.md (1)
2-5: Единство title/H1 сохраненоИ front-matter, и основной заголовок содержат «(Поделка)» — стиль выдержан, навигация станет понятнее.
docs/product/framework-elements/030-components-binding.md (1)
2-5: Корректное добавление аннотации&ПластилинДополнение в title и H1 выполнено правильно, ссылка на ключевую аннотацию сразу видна.
docs/product/framework-elements/160-additional-processing.md (1)
2-5: Аннотация&Напильникотражена последовательноЗаголовки синхронизированы; изменений по содержанию не требуется.
docs/product/framework-elements/050-dependency-injection.md (2)
2-5: Проверьте корректность якорей после изменения заголовкаДобавление суффикса «(Установить)» в Title и H1 изменит автоматически-сгенерированный slug (
#внедрение-зависимостей-в-поля-и-функции-сеттеры-установить). Убедитесь, что:
- Все внутренние/внешние ссылки на данный раздел обновлены.
- TOC-генератор вашего статического сайта корректно отображает новый заголовок.
Иначе навигация по документации может «сломаться».
29-31: Изменение текста выглядит корректнымОписание поведения внедрения через поле/сеттер осталось понятным, правки не затронули смысл.
docs/product/getting-started/20-first-steps.md (1)
27-27: Типографическая правка принятаФраза теперь читается грамотно и не сбивает с толку.
docs/product/framework-elements/100-aliases-grouping.md (1)
2-6: Обновлённый заголовок может изменить slugВставка «(&Прозвище)» изменит адрес секции (
#группировка-компонентов-по-алиасу-прозвище). Проверьте все ссылки/редиректы, особенно из файла090-aliases.md.docs/product/framework-elements/010-component-declaration.md (1)
14-18: Отличный акцент на аннотации &ЖелудьПример соответствует best-practice: аннотация вынесена отдельной строкой,
ПриСозданииОбъектабезЭкспорт.
| Помимо единичного желудя и массива, РокБэнд можно получить в виде соответствия (`"Соответствие"`), где ключом будет имя ~~панка~~ жёлудя, а значением - сам жёлудь, и в виде таблицы значений (`"ТаблицаЗначений"`), в каждой строке которой будет содержаться `Имя`, `ОпределениеЖелудя` и сам `Желудь`. | ||
|
|
||
| > И вообще, загляните в документацию библиотеки [autumn-collections](https://github.com/autumn-library/autumn-collections), там много вкусных типов! | ||
| И даже больше, РокБэнд можно получить своим собственным способом, для этого нужно создать у себя свой уникальный `СобирательПанков.os`, в котором нужно определить два метода, один который получает на входе панка и его описание, а второй который возвращает собранную банду | ||
| И даже больше, РокБэнд можно получить своим собственным способом, для этого нужно создать у себя свой уникальный `СобирательПанков.os`, в котором нужно определить два метода, один который получает на входе панка и его описание, а второй который возвращает собранную банду: | ||
|
|
There was a problem hiding this comment.
Пример кода содержит несуществующие переменные → падает на первом же запуске
В процедуре Добавить:
- Используется
Желудь, но параметр названПанк. - На строке 103 фигурирует
ОпределениеЖелудя, тогда как параметр —ОпределениеПанка. - Метод
Коллекция.Добавить(...)обращается к не объявленной переменнойКоллекция.
Предлагаемый минимальный фикс:
-Процедура Добавить(Панк, ОпределениеПанка) Экспорт
+Процедура Добавить(Панк, ОпределениеПанка) Экспорт
@@
- Банда.Вставить(РольИИсполнитель.Ключ, Желудь);
+ Банда.Вставить(РольИИсполнитель.Ключ, Панк);
@@
- Коллекция.Добавить(ОпределениеЖелудя.Имя());
+ Банда.Добавить(ОпределениеПанка.Имя());Без этих правок пример вводит читателя в заблуждение.
Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~82-~82: Избыточные определения. В правильно составленном предложении не должно быть больше одного придаточного определения.
Context: ...вой уникальный СобирательПанков.os, в котором нужно определить два метода, один который получает на входе панка и его описание,...
(OPREDELENIA)
🤖 Prompt for AI Agents
In docs/product/framework-elements/100-aliases-grouping.md around lines 78 to
83, the example code in the Добавить procedure uses inconsistent and undeclared
variable names causing runtime errors. Rename the parameter Желудь to Панк,
change ОпределениеЖелудя to ОпределениеПанка to match the parameter, and declare
or correctly reference the Коллекция variable before calling its Добавить
method. These changes will align variable names and declarations to prevent
immediate failures.
1 participant
Мне как начинающему пользователю
ОСени, в заголовках документации хочется видеть сущности, о которых идет речь. Кажется проще потом по оглавлению бегать ,чтобы найти описание нужной аннотации/поведения.