Dokumentowanie niestandardowych funkcji Python w QGIS

9

Jak mogę udokumentować moje niestandardowe funkcje Pythona w QGIS?

Chciałbym zaoferować użytkownikom pomoc w zakresie funkcji, które dla nich napisałem:

wprowadź opis zdjęcia tutaj

Próbowałem dodać ciąg dokumentów:

wprowadź opis zdjęcia tutaj

Ale za każdym razem, gdy klikam Załaduj , wyświetlany jest komunikat o błędzie:

wprowadź opis zdjęcia tutaj

Komunikat o błędzie wyraźnie pokazuje błąd wcięcia, który nie odpowiada mojemu faktycznemu kodowi.

BritishSteel
źródło

Odpowiedzi:

8

To, co robisz, to właściwy sposób na udokumentowanie niestandardowej funkcji.
Napotkany błąd polega na tym, że domyślnie podczas pisania funkcji w Edytorze funkcji wcięcie przed returninstrukcją to 4 znaki spacji, a nie „tabulator”. Po prostu sprawdź, czy tak jest. Wcięcie powinno być spójne (tylko spacje lub tabulacja).

nash
źródło
@ nash ma rację. Właśnie przetestowałem tę funkcję i wystąpił błąd tylko przy użyciu spacji zamiast 4 spacji. +1, dobra odpowiedź!
mgri
Dobre myślenie! Oznacza to, że komunikat o błędzie jest również poprawny. Dziwne jest to, że czasami, ale nie zawsze, po naciśnięciu Enter Enter QGIS używa tabulacji zamiast spacji, co oznacza, że ​​QGIS domyślnie dodaje błąd. Chociaż nie mogę zrozumieć, kiedy dokładnie nie robi tego poprawnie.
British Steel