Мета-ориентирование, баланс между классическим документированием и автодокументированием

Добрый день! Меня зовут Воронин Николай, я занимаюсь автоматизацией систем отчётности и анализа в ПГКДиджитал. Моя статья является структурированием личного опыта, полученного в конкретных условиях, он не претендует на статус best-practice, допускает ситуации, в которых могут существовать более эффективные решения или проблема не стоит в целом. Мета-ориентирование – это общее название, в рамках статьи, для совокупности навыков и подходов, облегчающих понимание частных алгоритмов и потоков данных в большой системе со сложными связями между множеством объектов. В моём случае речь пойдёт о комплексе нескольких BI систем, существующих параллельно, но сложности вполне могут возникать и в рамках одной, достаточно массивной системы отчётности.

https://habr.com/ru/companies/pgk/articles/919566/

#документирование_кода #навигация #метаданные #автодокументация #навыки #анализ

[Перевод] Создаём безукоризненную автодокументацию кода на Python с помощью Sphinx

В этой статье я расскажу о генераторе документации Sphinx , с помощью которого можно автоматически создавать документацию для модулей Python. Кроме того, я буду использовать шаблон проекта Cookiecutter Data Science в Visual Studio Code (VS Code), поскольку он легко интегрируется в Sphinx и имеет стандартизированную структуру директорий. Официальное пособие по использованию Sphinx — отличный ресурс для пользователей, которые хотят углубиться в детали. А моя статья — это краткое руководство по началу работы с этим инструментом.

https://habr.com/ru/companies/netologyru/articles/815563/

#python #документация #sphinx #data_science #автодокументация #docstrings #demopy #строки_документации #confpy #модули_python