Строки документации

Урок 8 из 28 курса Clean Code — пишите код лучше на Python на Coddy.

Строка документации, или docstring, обычно находится как первый оператор в определении модуля, функции, класса или метода.

Объявите docstring, заключив строку в """ или ''', например:

def complex(real=0.0, imag=0.0):
	"""
	Сформировать комплексное число.
	
		Параметры:
			real (float) -- действительная часть (по умолчанию 0.0)
			imag (float) -- мнимая часть (по умолчанию 0.0)
	"""
    if imag == 0.0 and real == 0.0:
        return complex_zero
    ...

обратите внимание, как здесь документируется функция complex(real, imag).

Обратите внимание на отступы в теле документации и на """

После использования docstring таким образом можно использовать свойство __doc__, чтобы получить документацию:

complex.__doc__

Будет выведено следующее:

Form a complex number.
	
	Parameters:
		real (float) -- the real part (default 0.0)
		imag (float) -- the imaginary part (default 0.0)

Задание

Легко

Вам дана функция с блочным комментарием вместо строки документации.

Ваша задача — заменить его допустимой строкой документации и проверить тестовый пример, чтобы добиться правильного форматирования строки документации!

Попробуйте сами

def sum_binary(a, b):
    # Calculate sum of two integers in binary formmated string
    # Parameters:
    # a (int) -- Integer number
    # b (int) -- Another integer number
    # Returns:
    # binary_sum (str) -- The sum of a and b in binary format
    sum = a + b
    binary_sum = bin(sum)
    return str(binary_sum)[1:] # Final formmating

print(sum_binary.__doc__)