Skip to content

docs fix - #97

Merged
littleboobs merged 1 commit into
ss220-space:masterfrom
Ksaikok46:docs-fix
May 25, 2026
Merged

docs fix#97
littleboobs merged 1 commit into
ss220-space:masterfrom
Ksaikok46:docs-fix

Conversation

@Ksaikok46

@Ksaikok46 Ksaikok46 commented May 25, 2026

Copy link
Copy Markdown
Collaborator

Информация о PR

Уточнение документации по хелперам и глобалварам

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread modular_nemesis/README.md
Comment on lines +287 to +288
Те же правила относятся к helper-функциям и глобальным переменным — их соответствующие папки это **`code/__HELPERS/~nemesis_helpers`**
и **`code/_globalvars/~nemesis_globalvars`**

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Аналитический отчёт от Немезиды. Обработка запроса завершена.

Приветствую! Я проанализировал предложенные Вами изменения. С технической точки зрения, работа выглядит удовлетворительно.

Сводка анализа:

  • 🔴 Критических замечаний: 0
  • 🟡 Рекомендаций: 1
  • 💡 Предложений: 0

🟡 Рекомендация по точности документации

Файл: modular_nemesis/README.md:287-288

Проблема: Фраза «Те же правила относятся...» вводит в заблуждение, так как она следует сразу за правилом об использовании #undef для очистки контекстного меню. Однако для хелперов (процедур) и глобальных переменных в DM механизм #undef не применим и не требуется. Это может запутать новых разработчиков.

Решение: Переформулировать предложение, чтобы оно указывало только на правила размещения в специальных папках (аналогично правилам для дефайнов из начала раздела). Также рекомендуется добавить тире перед «это» для корректной пунктуации.

Пояснение: Хелперы и глобальные переменные не являются макросами препроцессора, поэтому их нельзя «отменить» в конце файла. Очистка контекстного меню IDE для них работает иначе.

Suggested change
Те же правила относятся к helper-функциям и глобальным переменным — их соответствующие папки это **`code/__HELPERS/~nemesis_helpers`**
и **`code/_globalvars/~nemesis_globalvars`**
К хелперам и глобальным переменным также применяются правила модульного размещения. Их соответствующие папки это **code/__HELPERS/~nemesis_helpers**
и **code/_globalvars/~nemesis_globalvars**

@littleboobs
littleboobs merged commit b2b20cc into ss220-space:master May 25, 2026
26 checks passed
@Ksaikok46
Ksaikok46 deleted the docs-fix branch May 25, 2026 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants