Источник: Nuances of Programming Написание высококачественной документации для большого или сложного API упрощается простым, интуитивно понятным пакетом Python  —  pdoc3, включая также поддержку Markdown и LaTeX! Документация важна Все любят хорошую и полную документацию, особенно во время знакомства с новой библиотекой (хотя, даже и при миллионном её применении). Представьте, как бы вы себя чувствовали, если бы с веб-сайтов Scikit-learn или TensorFlow убрали всю документацию. Сразу ощущается беспомощность… Поэтому она важна...

Библиотека Pylint позволяет искать ошибки в коде и сделать его стилистически согласованным со стандартами Python. Надеюсь, что пост обогатит и ваш опыт работы с анализаторами кода. PEP-8 — является обобщённым стандартом для кода Python. Если код не форматировать по рекомендациям PEP-8, то читабельность кода резко понижается, следовательно, работа над проектом усложняется. Для помощи разработчикам существует множество автоматизированных инструментов для оптимизации и улучшении кода. Для выявления недочётов в нашем проекте я использовала библиотекy Python – Pylint...