документация для параметра из другого модуля - PullRequest
0 голосов
/ 22 марта 2020

Как указать в документации, что параметр поступает из другого модуля - это класс другого модуля?

В моем примере: file_writer из моего "базового" модуля - библиотека, которая необходима несколькими модулями. Параметр config взят из модуля, в котором находится метод "test_method".

def test_method(self, config, file_writer):
"""Method to do Something.

@param config: settings 
@type config: Configuration object
@param file_writer: object to write data to a file
@type file_writer: Writer object (base module) 

Более того, это хороший подход - использовать интерфейсы вместо классов?

...