Como posso fazer o parágrafo de preenchimento considerar as regras de formatação das documentações do Python?

7

Se eu pressionar M-quma sequência de caracteres como esta, as quebras de linha na sequência de caracteres serão confusas:

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

torna-se isso

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

Respostas:

3

python-docstring é um pacote que substitui o parágrafo de preenchimento, por isso é compatível com as instruções do Python. Ele funciona nos formatos sphinx-doc e reStructuredtext. Ele também fornece destaque de sintaxe, e acredito que destacará a marcação nos seus documentos.

Este pode ser um bom lugar para começar. Eu ainda não tentei, mas se você tiver um formato de documentação que não está incluído, deve ser possível estender o pacote. Para o seu caso de uso, imagino que seria um caso de editar as expressões regulares que detectam variáveis. No entanto, pode ser mais difícil fazê-lo funcionar para documentos no estilo do Google.

jcaw
fonte