fill-paragraphにPython docstringのフォーマットルールを考慮する方法を教えてください。


7

次のM-qようにdocstring を押し込むと、docstringの改行がめちゃくちゃになります。

def foo(word):
  """
  This is a function that does something.
  @param word: str, input.
  @returns: True
  """

これになる

def foo(word):
  """This is a function that does something. @param word:
  str, input. @returns: True
  """

回答:


3

python-docstringは、fill-paragraphをオーバーライドするパッケージであるため、Python docstringと互換性があります。これは、sphinx-doc形式とreStructuredtext形式の両方で機能します。また、構文の強調表示も提供します。ドキュメント文字列のマークアップを強調表示すると思います。

ここから始めるのが良いでしょう。私はまだ試していませんが、含まれていないdocstring形式がある場合は、パッケージを拡張できるはずです。あなたのユースケースでは、変数を検出する正規表現を編集するケースになると思います。ただし、Googleスタイルのドキュメント文字列で機能させるのは難しいかもしれません。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.