Вопрос №55738 от пользователя Denys Bondarenko в уроке «Инициализация и протоколы», курс «Python: Введение в ООП»
Приветствую!
Подскажите пожалуйста, объязательно ли добавлять docstring в каждый __init__ объекта? Мы ведь даже к docstring не обращаеся help(Counter.__init__) ?
Линтер сообщает D107 Missing docstring in __init__ - я добавил, в повелительном наклонении во избежания с ним проблем (все для линтера).
Линтер, который мы используем, достаточно строг. И мы пока не везде отключили требование писать docstrings - уж очень много таких мест :(
Мы ведь даже к docstring не обращается
help(Counter.__init__)?
Если вывести help(Counter), то справочная система покажет docstrings ко всем методам. А ещё строки документации показывает IDE. Кроме того, на практике часто используют инструменты вроде Sphinx, которые строят настоящую документацию именно по docscrings, которые вы оставляете в коде. Так что описывать все сущности, которые предназначены для общего пользования (__init__ тоже к таковым относится) определённо стоит!
Используйте Хекслет по-максимуму!
- Задавайте вопросы по уроку
- Проверяйте знания в квизах
- Проходите практику прямо в браузере
- Отслеживайте свой прогресс
Зарегистрируйтесь или войдите в свой аккаунт