Сокращение избыточности в строках документа Python при использовании документов pylint - PullRequest
0 голосов
/ 01 июня 2018

Я пишу некоторый код Python, который проверяется с помощью pylint с расширением docparams .Это требует документирования параметров функции в их строках документации.У меня есть тенденция пытаться разложить функции настолько, насколько это возможно, и в конечном итоге получить множество функций, которые вызывают другие функции - часто разделяя многие из одних и тех же параметров.Это может привести к большому количеству избыточной (вставленной при копировании) документации в строках документов.Есть ли рекомендуемый способ справиться с ситуацией такого типа?

1 Ответ

0 голосов
/ 01 июня 2018

Я столкнусь с этой же проблемой позже, работая над приложением Pyramid, так что я погуглил и нашел docrep .Я думаю, что это удовлетворит обе наши потребности.

...