タグ付けされた質問 「documentation」

このタグはドキュメントジェネレーター専用です。言語やSDEタグも含めます。文書やツールへのリンクを求めるため、またはベンダーの文書を批判するために使用しないでください。

3
複雑なAPI関数に対する小さな変更を文書化する方法は?
いくつかのライブラリからインポートされた複雑なAPI関数があるとします。 def complex_api_function( number, <lots of positional arguments>, <lots of keyword arguments>): '''really long docstring''' # lots of code 小さな変更を加えるために、その関数の周りに簡単なラッパーを書きたいと思います。たとえば、最初の引数を文字列として渡すことができるはずです。これを文書化する方法は?私は次のオプションを検討しました: オプション1: def my_complex_api_function(number_or_str, *args, **kwargs): ''' Do something complex. Like `complex_api_function`, but first argument can be a string. Parameters ---------- number_or_str : int or float or str Can be a …
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.