¿Cómo puedo hacer que el párrafo de relleno considere las reglas de formato de las cadenas de documentos de Python?

7

Si M-qpresiono una cadena de documentación como esta, entonces los saltos de línea en la cadena de documentación se estropean:

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

se convierte en esto

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

Respuestas:

3

python-docstring es un paquete que anula el párrafo de relleno por lo que es compatible con las cadenas de documentos de Python. Funciona para los formatos sphinx-doc y reStructuredtext. También proporciona resaltado de sintaxis, y creo que resaltará el marcado en sus cadenas de documentos.

Este puede ser un buen lugar para comenzar. No lo he probado yo mismo, pero si tiene un formato de cadena de documentos que no está incluido, debería ser posible extender el paquete. Para su caso de uso, me imagino que sería un caso de edición de las expresiones regulares que detectan variables. Sin embargo, podría ser más difícil hacer que funcione para las cadenas de documentos al estilo de Google.

jcaw
fuente