e-nms_qa_automation/docs/config/add_docstring.md

1.4 KiB
Raw Permalink Blame History

Добавление Docstring

Изменить соблюдая требования:

  1. Добавить недостающие и улучшить имеющиеся docstrings язык русский.

  2. Сделать docstring более компактными, сохранив всю важную информацию.

  3. Ограничить в docstring длину строк 79 символами.

  4. Добавить docstring перед импортами.

  5. Должна быть пустая строка после каждого docstring.

  6. Сохранить все текущие комментарии.

  7. Запрещено изменять код (изменять только docstring).

  8. Не удалять пустые строки.

  9. В конце кода должна быть одна пустая строка.

Пример добавления Docstring с помощью ИИ "DeepSeek":

  • Загрузить: DeepSeek файл проекта my_name.py и docs/config/add_docstring.md.
  • Запросить: Изменить строго соблюдая требования,вывести полный изменённый код и отчет о выполнении требований.
  • Проверить результат сравнением изменений сделанными в коде ИИ "DeepSeek" с помощью notepad++.