PydocstyleはPythonのdocstringsに警告を出すソフトウェアです。これらの警告のいくつかはコンピュータで簡単に修正できます。
例えば
- D209 複数行のドキュメント文字列の閉じ引用符は別の行に記述する必要があります
- D400 最初の行はピリオドで終わる必要があります
- D409 セクションの下線はセクション名の長さと一致する必要があります
- もっと
このタイプのエラーを自動的に修正する方法やソフトウェアはありますか? 必要に応じて、pydocstyle はエラーのファイル名と行番号を提供できます。
特記事項: Google スタイルの docstring で動作するソフトウェアをいくつか見つけました。特に NumPy スタイルの docstring が必要です。