У меня возникли проблемы с пониманием предположений фона для чтения документации Python.Понимание документации на Python: как узнать, что возвращает функция?
Пример: Документацию по функции importlib.import_module
можно найти по адресу https://docs.python.org/3/library/importlib.html#importlib.import_module. Документация по функциям не указывает возвращаемое значение для функции, но она (возможно, очевидно) возвращает модуль, который он только что загрузил.
Я чувствую, что на самом деле есть много функций, для которых возвращаемое значение не указано. Я пытаюсь решить, какой из следующих вариантов ближе всего к истине.
- Документация по этой функции является неполной. Не будь таким параноидальным.
- Всякий раз, когда нет указанного возвращаемого значения, предполагается, что функция является достаточно автоматическим документированием, что вы можете ее обработать. Просто присвойте имя возвращаемому значению:
foo = f(bar)
, а затемprint(foo)
. - Существует обычный способ узнать, что такое возвращаемое значение, и мне нужно изучить соглашение.
Case 3, очевидно, тот, который меня действительно волнует!
Любой совет будет очень благодарен.
1). Любая хорошая документация должна указывать возвращаемое значение на начальных строках, либо с возвращаемым значением слева от функции, либо с помощью «Возвраты:» outdented, а затем обсуждать, что такое аргументы. К сожалению, люди, которые являются хорошими программистами, как правило, являются полными идиотами в отношении объяснения своих изобретений. Однако вы должны быть благодарны: документы python в 10 раз лучше, чем рубиновые документы. – 7stud
@ 7stud Итак, вы говорите, что программисты на Ruby более хороши, чем программисты на Python? –