docstring

3Hitze

1Antwort

Python DocString mit Vim Pythoncomplete zeigt keine Zeilenumbrüche für meine eigenen Klassenfunktionen

Ich bekomme einige unerwartete Ergebnisse, wenn ich versuche, Python Omni Completion auf meine eigenen Klassenfunktionen zu verwenden. Das docstring für die Funktionen ist nicht richtig mit Zeilenumbr

9Hitze

3Antwort

Automatisierte Möglichkeit, von der Docstring-Formatierung von epydoc zur Formatierung von Sphinx-Docstrings zu wechseln?

Ich habe ein Projekt, das ich mit epydoc dokumentiert habe. Jetzt versuche ich zur Sphinx zu wechseln. Ich formatierte alle meine Docstrings für epydocs, benutze B {}, L {} etc zum Fettmachen, Verknüp

1Hitze

1Antwort

Wie würde ich diese einfache Python-Klasse und ihren Docstring verbessern?

Dies ist ein einfacher Filter, den ich für ein Projekt verwendet habe, das Daten über eine serielle Verbindung liest, und dachte, es wäre gut, ihn als meinen ersten Versuch zu benutzen, Docstrings zu

10Hitze

1Antwort

Referenzieren von Parametern in einem Python-Docstring

Ich benutze Sphinx und die Autodocs-Funktion, um sicherzustellen, dass wir gute Dokumente in unserem Projekt haben. Also ich bin vertraut mit info field lists und ich bin vertraut mit der Verwendung c

6Hitze

2Antwort

Unterscheidet sich Docstring maximale Zeilenlänge vom normalen PEP8-Standard?

Also im Blick auf einige Code und bringen es auf PEP 8 Standard mit Hilfe von pylint und ich bemerkte, dass, wenn ich Triple Anführungszeichen für eine Druckanweisung, wo der Text 120 Zeichen ging (wi

10Hitze

4Antwort

Vererben Sie eine übergeordnete Klasse docstring als __doc__ Attribut

Es gibt eine Frage über Inherit docstrings in Python class inheritance, aber die Antworten dort befassen sich mit Methode Docstrings. Meine Frage ist, wie man einen Docstring einer Elternklasse als __

22Hitze

2Antwort

Clojure-Dokumentation für Bibliotheken/Namespaces

Wie fügen Sie Docstrings und/oder Kommentare zu Clojure-Bibliotheken/Namespaces als Ganzes hinzu, d. H. Nicht nur zu bestimmten Funktionen im Namespace? Ich habe festgestellt, dass die Clojure-Quelle

9Hitze

1Antwort

Was bedeuten diese Formate im Docstring von twisted?

Im Quellcode von twisted enthalten viele Docstrings folgende Formate: L {xxx} oder C {xxx} oder eine Zeile beginnt mit einem '@', was bedeuten sie? zum Beispiel in der verdrehten/Internet/interfaces.p

38Hitze

6Antwort

Wie programmiere ich den Docstring programmatisch?

Ich habe eine Wrapper-Funktion, die eine Funktion zurückgibt. Gibt es eine Möglichkeit, den Docstring der zurückgegebenen Funktion programmgesteuert festzulegen? Wenn ich __doc__ schreiben könnte würd

9Hitze

1Antwort

Wie man docstring für __init__ in Python C-Erweiterung angibt

Vielleicht eine dumme Frage: Wie kann man Docstring für spezielle Funktionen wie __init__ beim Schreiben einer C-Erweiterung angeben? Für normale Methoden enthält die Methodentabelle eine Voreinstellu