Как понять структуру английской документации функции: parameters, returns, raises?

Документация функции почти везде устроена одинаково, разберём по разделам:

• Parameters / Arguments — что подавать на вход. Здесь список аргументов: имя, тип, описание. Самое важное для вызова — читай первым.
• Returns — что функция вернёт. Тип и смысл результата (например Returns: list of str = «вернёт список строк»).
• Raises / Throws — какие ошибки может выбросить и при каких условиях (Raises: ValueError if input is empty). Полезно, чтобы знать, что ловить.
• Examples — готовые примеры вызова. Часто понятнее всего остального.

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

1. Сначала Examples — скопировал, попробовал, увидел как работает.
2. Потом Parameters — если надо поменять под себя.
3. Returns — чтобы знать, что присваивать.
4. Raises — когда дойдёшь до обработки ошибок.

Эта структура одинаковая в Python, JS, Java — выучив её раз, читаешь доку любой библиотеки.