Обычно целью добавления добавления строки документа в начало функции является описание функции, что она делает, что она будет возвращать, и описание параметров. Вы можете добавить детали реализации, если это необходимо. Даже вы можете добавить информацию об авторе, который написал код для будущего разработчика.
по вашему мнению, является значимой строкой документации? Что вы ожидаете, что там будет описано?
Например, рассмотрим этот класс Python__init__
:
def __init__(self, name, value, displayName=None, matchingRule="strict"):
"""
name - field name
value - field value
displayName - nice display name, if empty will be set to field name
matchingRule - I have no idea what this does, set to strict by default
"""
Считаете ли вы это значимым? Опубликуйте ваши хорошие / плохие примеры, чтобы все знали (и общий ответ, чтобы его можно было принять).