docstring

5Hitze

2Antwort

Wie würde ich einen Python Docstring hübsch drucken?

Ich habe eine Python-Datei mit rohen Strings als Docstrings. def a(): '\n\tthis\n\tis\n\tthe docstring.\n\t' print 'hello world' wie würde ich schreiben die docstring aussehen def a():

6Hitze

2Antwort

Parsing Funktion docstring in sphinx.autodoc Format

ich viele Funktionen in Python von der Art haben: def foobar(one, two): """ My function. :param int one: My one argument. :param int two: My two argument. :rtype: Something ni

55Hitze

3Antwort

Benutzerdefinierte PyCharm-Docstring-Stubs (d. H. Für google Docstring- oder numpydoc-Formate)

Bietet PyCharm 2.7 (oder wird PyCharm 3) Unterstützung für benutzerdefinierte Docstring- und Doctest-Stubs? Wenn ja, wie schreibt man diesen spezifischen Typ von benutzerdefinierter Erweiterung? Mein

5Hitze

1Antwort

Kanonischer Weg in Python zum Hinzufügen oder Abrufen von Metainformationen zu/von Docstrings?

Ich möchte einige Metainformationen zu den Dokumentenstrings meiner Python-Module hinzufügen, z. B. Autor, E-Mail, Version. Gibt es einen kanonischen Weg, das zu tun? Ich habe eine ganze Weile gesucht

7Hitze

1Antwort

Wie bekomme ich Sphinx, um den GPL-Hinweis in meinem Docstring zu ignorieren?

Ich verwende Sphinx, um mein Python-Paket zu dokumentieren. Als ich die automodule Richtlinie über mein Modul verwenden: .. automodule:: mymodule :members: Er druckt alles, einschließlich der GPL B

14Hitze

1Antwort

PEP 257 Docstring in der Standardbibliothek?

PEP 257 sagt: Docstring Bearbeitungswerkzeuge aus der zweiten und der weiteren Zeilen der docstring, gleich der minimalen Einbuchtung aller nicht leeren Zeilen nach der ersten Zeile einen gleichförmig

11Hitze

3Antwort

In Django RestFramework, wie ändert man die Api-Root-Dokumentation?

Gibt es in django RestFramework eine "offizielle" Möglichkeit, die Dokumentation für den "Api Root" zu generieren? Nachdem in den Quellcode der RestFramework suchen, habe ich von Subklassen die defaul

24Hitze

2Antwort

Funktionsname + Tab nicht docstring zurückkehrt in IPython

In IPython, ich bin es gewohnt, Funktion ( zu schreiben und dann einen Reiter schlagen, und erhielt den Inhalt des docstring und einer Liste der benannten Argumente. dies ist jedoch aufgehört zu arbei

6Hitze

1Antwort

Wie python docstring für dict hinzufügen

Was ist die empfohlene Methode zum Hinzufügen eines Docstring für einen Wörterbuchparameter? Ich kann mehrere Zeile doc-string Beispiele here sehen. Ich muss die Eingabeargumente zu einer Funktion im

5Hitze

2Antwort

Python 3 - Methode Docstring-Vererbung, ohne Dekoratoren zu zerstören oder DRY zu verletzen

Diese Frage scheint sowohl bei StackOverflow als auch anderswo regelmäßig aufzutauchen, aber ich konnte nirgendwo eine völlig zufriedenstellende Lösung finden. Es scheint zwei Arten von gemeinsamen Lö