Создание строки документации
Вы решили написать лучший в мире пакет Python с открытым исходным кодом для обработки естественного языка. Он должен произвести такую же революцию в работе с неструктурированным текстом, какую numpy произвёл для массивов, pandas — для табличных данных, а scikit-learn — для машинного обучения.
Первая функция, которую вы пишете, — count_letter(). Она принимает строку и один символ и возвращает количество вхождений этого символа в строку. Чтобы пользователи вашего пакета могли легко разобраться в том, как работает эта функция, необходимо снабдить её строкой документации. Создайте строку документации в стиле Google, выполнив следующие шаги.
Это упражнение является частью курса
Написание функций на Python
Интерактивное практическое упражнение
Попробуйте выполнить это упражнение, дополнив этот пример кода.
# Add a docstring to count_letter()
def count_letter(content, letter):
____
if (not isinstance(letter, str)) or len(letter) != 1:
raise ValueError('`letter` must be a single character string.')
return len([char for char in content if char == letter])