python: __doc__ doc trings отображается как none

Question

Я написал относительно простой скрипт с использованием python, а также написал строки документации для всех методов следующим образом:

def processData(rawData):
    """Proccessing raw data from weather station using Regex to get final sensor readings.

    Args:
        rawData: A string contains all the sensor readings. This string will be processed
                 using regex to remove garbage.

    Returns:
        finalList: A list of final sensor readings."""

Однако, когда я пытался напечатать строки документа через интерпретатор, строки документа выводились как «Нет»

>>> import ws100_weather_data as weather
>>> print weather.__doc__
None

Но справка (погода) отображает все строки документа, а также другую информацию. Так я тут что-то не так делаю? Если да, то как правильно получить доступ к строкам документов?

Спасибо.

Answer 1

Существуют разные строки документов для разных объектов. Строка документации для вашей функции будет processData.__doc__, для модуля - weather.__doc__, которую вы не определили. Определите это как пустую строку (неназначенную) в глобальной области видимости вверху файла.

Answer 2

Вы показываете нам строку документа одного метода. Предположительно у вас нет строки документа для класса.