NumPyドキュメントのガイド
Guide Numpy Documentation
ユーザードキュメント
- 一般的に、私たちは Google開発者向けドキュメントスタイルガイド 。
-
NumPyスタイルは、次の場合に適用されます。
- Googleにはガイダンスがない、または
- Googleスタイルは使用しないことをお勧めします
現在のルール：
- 複数化する 索引 なので インデックス それよりも インデックス 、の前例に続いて
numpy.indices。 - 一貫性を保つために、複数形にもしています マトリックス なので 配列 。
- NumPyまたはGoogleのルールで不適切に対処されている文法上の問題は、最新版の文法と使用法のセクションで決定されています。 シカゴマニュアルオブスタイル 。
- 歓迎します 警告 場合によっては、NumPyスタイルのルールに追加する必要があります。
Docstrings
使用する場合 スフィンクス numpyの規則と組み合わせて、docstringが正しく処理されるようにするためのnumpydoc拡張子。たとえば、Sphinxはdocstringのパラメータセクションをフィールドリストに変換します。使用するnumpydocは、セクションヘッダー（例：-------------）そのスフィンクスはdocstringsで見つけることを期待していません。
このドキュメントで説明されている一部の機能には、最新バージョンのが必要です。numpydoc。たとえば、 収量 セクションが追加されましたnumpydoc0.6。
それはから利用可能です：
numpy内のドキュメントの場合、行う必要はないことに注意してください例の最初にnumpyをnpとしてインポートします。ただし、次のような一部のサブモジュールfftはデフォルトではインポートされないため、明示的に含める必要があります。
import numpy.fft
その後、それを使用することができます：
np.fft.fft2(...)