Я не нашел никакой лучшей практики относительно того, что должно быть задокументировано в классах и строках документации __init__
. Иногда я нахожу, что аргументы конструктора уже задокументированы в строке документации классов, иногда они описаны в строке документации __init__
. Я предпочитаю описывать конструкцию внутри docstring классов, так как это то, что вы называете при создании нового экземпляра. Но что тогда должно быть документировано в строке документации по методам __init__
?
Редактирование:
Я знаю о руководстве по стилям Google и о стиле goc docstring, но оба не отвечают на мой вопрос. Пример стиля строки документа говорит
Метод
__init__
может быть задокументирован на уровне класса строка документа или как строка документа самого метода__init__
. Любая форма является приемлемой, но эти два не должны смешиваться. Выбери один соглашение о документировании метода__init__
и его соблюдении.
Но если я решу поместить строку документации функции __init__
в строку документации уровня класса, что должна содержать строка документации __init__
?