Вопрос №55738 от пользователя Denys Bondarenko в уроке «Инициализация и протоколы», курс «Python: Введение в ООП»

Denys Bondarenko

Приветствую! Подскажите пожалуйста, объязательно ли добавлять docstring в каждый __init__ объекта? Мы ведь даже к docstring не обращаеся help(Counter.__init__) ? Линтер сообщает D107 Missing docstring in __init__ - я добавил, в повелительном наклонении во избежания с ним проблем (все для линтера).

1 0

Aleksei Pirogov

Линтер, который мы используем, достаточно строг. И мы пока не везде отключили требование писать docstrings - уж очень много таких мест :(

Мы ведь даже к docstring не обращается help(Counter.__init__) ?

Если вывести help(Counter), то справочная система покажет docstrings ко всем методам. А ещё строки документации показывает IDE. Кроме того, на практике часто используют инструменты вроде Sphinx, которые строят настоящую документацию именно по docscrings, которые вы оставляете в коде. Так что описывать все сущности, которые предназначены для общего пользования (__init__ тоже к таковым относится) определённо стоит!

1

Используйте Хекслет по максимуму!

  • Задавайте вопросы по уроку
  • Проверяйте знания в квизах
  • Проходите практику прямо в браузере
  • Отслеживайте свой прогресс

Зарегистрируйтесь или войдите в свой аккаунт

Даю согласие на обработку персональных данных, соглашаюсь с «Политикой конфиденциальности» и «Условиями оказания услуг»

Рекомендуемые программы

С нуля до разработчика. Возвращаем деньги, если не удалось найти работу.

Иконка программы Фронтенд-разработчик
Профессия
Разработка фронтенд-компонентов веб-приложений
25 мая 10 месяцев
Иконка программы Python-разработчик
Профессия
Разработка веб-приложений на Django
25 мая 10 месяцев
Иконка программы PHP-разработчик
Профессия
Разработка веб-приложений на Laravel
25 мая 10 месяцев
Иконка программы Node.js-разработчик
Профессия
Разработка бэкенд-компонентов веб-приложений
25 мая 10 месяцев
Иконка программы Fullstack-разработчик
Профессия
Новый
Разработка фронтенд и бэкенд компонентов веб-приложений
25 мая 16 месяцев
Иконка программы Верстальщик
Профессия
Вёрстка с использованием последних стандартов CSS
в любое время 5 месяцев
Иконка программы Java-разработчик
Профессия
Разработка приложений на языке Java
25 мая 10 месяцев
Иконка программы Разработчик на Ruby on Rails
Профессия
Создает веб-приложения со скоростью света
25 мая 5 месяцев