Dokumentieren benutzerdefinierter Python-Funktionen in QGIS

Wie kann ich meine benutzerdefinierten Python-Funktionen in QGIS dokumentieren?

Ich möchte den Benutzern Hilfe für Funktionen anbieten, die ich für sie geschrieben habe:

Ich habe versucht, eine Dokumentzeichenfolge hinzuzufügen:

Aber wenn ich auf Laden klicke, wird eine Fehlermeldung angezeigt:

Die Fehlermeldung zeigt deutlich einen Einrückungsfehler an, der nicht meinem tatsächlichen Code entspricht.

— BritishSteel
quelle

Was Sie tun, ist der richtige Weg, um Ihre benutzerdefinierte Funktion zu dokumentieren.
Der Fehler, auf den Sie stoßen, ist, dass beim Schreiben einer Funktion im Funktionseditor standardmäßig der Einzug vor der returnAnweisung aus 4 Leerzeichen und nicht aus 'Tabulatorzeichen' besteht. Überprüfen Sie einfach, ob dies der Fall ist. Der Einzug sollte konsistent sein (entweder nur Leerzeichen oder Leerzeichen).

— nash
quelle

@ Nash ist richtig. Ich habe gerade die Funktion getestet und es gibt nur einen Fehler, wenn ein Tabulator anstelle von 4 Leerzeichen verwendet wird. +1, gute Antwort!

— Mgri

Gute Idee! Dies bedeutet, dass auch die Fehlermeldung korrekt ist. Es ist seltsam, dass manchmal, aber nicht immer, wenn Sie die Eingabetaste drücken, QGIS anstelle von Leerzeichen eine Registerkarte verwendet, was bedeutet, dass QGIS standardmäßig einen Fehler hinzufügt. Obwohl ich nicht herausfinden kann, wann genau es nicht richtig funktioniert.

— BritishSteel