docs fix - #97
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the documentation in modular_nemesis/README.md to include guidelines for helper functions and global variables, specifically defining their required folder locations within the modular system. Feedback was provided to rephrase the added text to avoid misleading developers into thinking that the #undef directive applies to helpers and global variables, as it only applies to defines. The reviewer provided a specific suggestion to clarify that only the modular placement rules are shared.
| Те же правила относятся к helper-функциям и глобальным переменным — их соответствующие папки это **`code/__HELPERS/~nemesis_helpers`** | ||
| и **`code/_globalvars/~nemesis_globalvars`** |
There was a problem hiding this comment.
Аналитический отчёт от Немезиды. Обработка запроса завершена.
Приветствую! Я проанализировал предложенные Вами изменения. С технической точки зрения, работа выглядит удовлетворительно.
Сводка анализа:
- 🔴 Критических замечаний: 0
- 🟡 Рекомендаций: 1
- 💡 Предложений: 0
🟡 Рекомендация по точности документации
Файл:
modular_nemesis/README.md:287-288Проблема: Фраза «Те же правила относятся...» вводит в заблуждение, так как она следует сразу за правилом об использовании
#undefдля очистки контекстного меню. Однако для хелперов (процедур) и глобальных переменных в DM механизм#undefне применим и не требуется. Это может запутать новых разработчиков.Решение: Переформулировать предложение, чтобы оно указывало только на правила размещения в специальных папках (аналогично правилам для дефайнов из начала раздела). Также рекомендуется добавить тире перед «это» для корректной пунктуации.
Пояснение: Хелперы и глобальные переменные не являются макросами препроцессора, поэтому их нельзя «отменить» в конце файла. Очистка контекстного меню IDE для них работает иначе.
| Те же правила относятся к helper-функциям и глобальным переменным — их соответствующие папки это **`code/__HELPERS/~nemesis_helpers`** | |
| и **`code/_globalvars/~nemesis_globalvars`** | |
| К хелперам и глобальным переменным также применяются правила модульного размещения. Их соответствующие папки — это **code/__HELPERS/~nemesis_helpers** | |
| и **code/_globalvars/~nemesis_globalvars** |
Информация о PR
Уточнение документации по хелперам и глобалварам