2017-02-08 7 views
6

私はNumpyのドキュメントを必要とするプロジェクトに取り組んでいます。私のJavaの時代には、Eclipse/IDEAでJavadocの順守をチェックしていたことを覚えています。 Numpyのドキュメントスタイルの順守をチェックする同等品はありますか?Numpyのドキュメントスタイルの順守をチェックするためのPythonファイルの埋め込み方法はありますか?

私はPEP257について知っていますが、Numpyのマニュアルについては具体的なチェックがないようです。

答えて

3

パイリンツはこれをサポートしているようです。 pylint.extensions.docparamsをご覧ください。

まとめてください。あなたの.pylintrcのマスターセクションに

load-plugins=pylint.extensions.docparams 

を追加することにより、pylintのこのチェッカーを活性化させます。このチェッカーは、すべての関数、メソッド、およびコンストラクタ ドキュメンテーション文字列が

  • パラメータとその種類

  • 戻り値とその型

  • 例外のドキュメントを含むことを検証

    盛り上がった


実際pydocstyle(旧pep257)numpyのドキュメンテーション文字列の大会のためrecently added support。しかし、それは完璧ではありませんが、あなたが達成したいことに最も近いと思うし、おそらく近い将来改善するでしょう。チェッカーは、(例えばスフィンクスなど特に)numpyのスタイルを処理し、それらのものをチェックし、私はそれがそれらの他のスタイルから、それを差別化する方法を持っていないと思うことができ

pydocstyle --convention=numpy example.py 
+0

。例えば、あなたがnumpyのスタイルだけを必要としていても、linterがそれが大丈夫だと言っているSphinxのドキュメントを書いた場合 - 排他的なドキュメントスタイルを指定する方法が見当たらない場合 – Andrew

+0

@Andrew、hmmm私は見逃してしまいましたその遵守の一部を考慮に入れて、私は自分の答えを更新しました。 –

関連する問題