[解決済み] **kwargsパラメータの正しい記述方法とは?
2022-08-31 15:10:02
質問
私は
スフィンクス
と
autodoc 拡張
を使用して、私のPythonモジュールのAPIドキュメントを生成しています。 特定のパラメータをうまく文書化する方法はわかりますが、特定のパラメータを文書化する方法の例が見つかりません。
**kwargs
パラメータをどのように文書化するかの例を見つけることができません。
これらを明確に文書化する良い例をどなたかご存知でしょうか?
どのように解決するのですか?
私が思うに
subprocess
-モジュールのドキュメント
は良い例です。の全パラメータを網羅的に記述してください。
top/parent クラス
. そして、そのリストを参照し、他のすべての
**kwargs
.
関連
-
[解決済み] Pythonのリストメソッドであるappendとextendの違いは何ですか?
-
[解決済み] Pythonで型をチェックする標準的な方法は何ですか?
-
[解決済み] ファイルに行を書き込む正しい方法?
-
[解決済み] Pythonでホームディレクトリを取得するための正しいクロスプラットフォームな方法は何ですか?
-
[解決済み] 2次元アレイにおけるピーク検出
-
[解決済み】__str__と__repr__の違いは何ですか?
-
[解決済み】クラスメソッドの目的は何ですか?
-
[解決済み] Pythonです。未束縛のメソッドを束縛する?
-
[解決済み] Python Logging でログメッセージが2回表示される件
-
[解決済み] djangoフレームワークでフォームフィールドから値を取得するには?
最新
-
nginxです。[emerg] 0.0.0.0:80 への bind() に失敗しました (98: アドレスは既に使用中です)
-
htmlページでギリシャ文字を使うには
-
ピュアhtml+cssでの要素読み込み効果
-
純粋なhtml + cssで五輪を実現するサンプルコード
-
ナビゲーションバー・ドロップダウンメニューのHTML+CSSサンプルコード
-
タイピング効果を実現するピュアhtml+css
-
htmlの選択ボックスのプレースホルダー作成に関する質問
-
html css3 伸縮しない 画像表示効果
-
トップナビゲーションバーメニュー作成用HTML+CSS
-
html+css 実装 サイバーパンク風ボタン
おすすめ
-
[解決済み] Pythonのdictをkwargsに変換する?
-
[解決済み] 前月の日時オブジェクトを返す
-
[解決済み] PythonでファイルのMD5チェックサムを計算するには?重複
-
[解決済み] 範囲指定された浮動小数点数のランダムな配列を生成します。
-
[解決済み] サブフォルダからのインポートモジュール
-
[解決済み] PyQtアプリケーションのスレッド化。QtスレッドとPythonスレッドのどちらを使うか?
-
[解決済み] Celeryタスクのユニットテストはどのように行うのですか?
-
[解決済み] PySparkでデータフレームのカラムをString型からDouble型に変更する方法は?
-
[解決済み] Python の sorted() はどのようなアルゴリズムを使っているのですか?重複
-
[解決済み] Pythonでリストが空かどうかをチェックする方法は?重複