1. ホーム
  2. python

[解決済み] **kwargsパラメータの正しい記述方法とは?

2022-08-31 15:10:02

質問

私は スフィンクス autodoc 拡張 を使用して、私のPythonモジュールのAPIドキュメントを生成しています。 特定のパラメータをうまく文書化する方法はわかりますが、特定のパラメータを文書化する方法の例が見つかりません。 **kwargs パラメータをどのように文書化するかの例を見つけることができません。

これらを明確に文書化する良い例をどなたかご存知でしょうか?

どのように解決するのですか?

私が思うに subprocess -モジュールのドキュメント は良い例です。の全パラメータを網羅的に記述してください。 top/parent クラス . そして、そのリストを参照し、他のすべての **kwargs .