Wenn ich M-qeinen Docstring wie diesen drücke, werden die Zeilenumbrüche im Docstring durcheinander gebracht:
def foo(word):
"""
This is a function that does something.
@param word: str, input.
@returns: True
"""
wird dies
def foo(word):
"""This is a function that does something. @param word:
str, input. @returns: True
"""
python-docstring ist ein Paket, das Fill-Paragraph überschreibt, damit es mit Python-Docstrings kompatibel ist. Es funktioniert sowohl für das Sphinx-Doc- als auch für das reStructuredtext-Format. Es bietet auch Syntaxhervorhebungen, und ich glaube, dass Markups in Ihren Dokumentzeichenfolgen hervorgehoben werden.
Dies kann ein guter Anfang sein. Ich habe es nicht selbst versucht, aber wenn Sie ein Dokumentzeichenfolgenformat haben, das nicht enthalten ist, sollte es möglich sein, das Paket zu erweitern. Für Ihren Anwendungsfall würde ich mir vorstellen, die regulären Ausdrücke zu bearbeiten, die Variablen erkennen. Es könnte jedoch schwieriger sein, es für Docstrings im Google-Stil zum Laufen zu bringen.