Python Docstring：raise vs. raises

Question

私はPyCharm IDEを使用して、PEP0257準拠のドキュメントストリングを作成します。それは私が全くの区別/使用を理解していない2つの属性が用意されています:raise Exception: exception explanation here

:raises Exception: exception explanation here

私のdocstringにraisesに反対するとして、私はraiseを使用する

• ？具体的には、クラスが提供されていない引数を必要とし、それを文書化するために使用されるTypeErrorが発生した場合、

Answer 1

TLは、DR

raisesが上昇される可能性のある例外を記述するために使用されます。 raiseは、Sphinxによって認識され、autodocを実行していて、raisesと同じです。

詳しい説明

PyCharmは、コメントをドキュメンテーション文字列のいくつかの異なるスタイルを使用するのに役立ちます。

私は頻繁に使用する

三は、以下のとおりです。これらの全てにおいて

1. NumPy Format
2. Google Format
3. Sphinx（フォーマットよりもはるかに）

Raisesのための特別なセクションがあります古いバージョンのPyCharmコードテストで見ることができます：

1. Simple NumPy
2. Simple Google

SphinxDocStringの実装私たちすることができますが認識することができ、多数のキーワードがありますsee here。これらのタグはRAISES_TAGSのリストにリンクしています。hereがあります。

この情報が役立つことを願っています。