Mendokumentasikan fungsi Python khusus di QGIS

9

Bagaimana saya bisa mendokumentasikan fungsi Python khusus saya di QGIS?

Saya ingin menawarkan bantuan kepada pengguna untuk fungsi yang saya tulis untuk mereka:

masukkan deskripsi gambar di sini

Saya sudah mencoba menambahkan docstring:

masukkan deskripsi gambar di sini

Tetapi setiap kali saya mengklik Muat pesan kesalahan ditampilkan:

masukkan deskripsi gambar di sini

Pesan kesalahan jelas menunjukkan kesalahan lekukan, yang tidak sesuai dengan kode saya yang sebenarnya.

qgis python field-calculator qgis-custom-function BritishSteel
sumber

Jawaban:

8

Apa yang Anda lakukan adalah cara yang benar untuk mendokumentasikan fungsi khusus Anda.
Kesalahan yang Anda temui adalah karena secara default ketika Anda menulis fungsi di Function Editor , lekukan sebelum returnpernyataan adalah bahwa dari 4 spasi karakter dan bukan 'ruang tab'. Periksa apakah itu masalahnya. Lekukan harus konsisten (hanya spasi atau spasi tab).

nash
sumber
@ nash benar. Saya baru saja menguji fungsi dan ada kesalahan hanya ketika menggunakan ruang tab bukannya 4 spasi. +1, jawaban yang bagus!
mgri
Pemikiran yang bagus! Ini berarti bahwa pesan kesalahan juga benar. Sungguh aneh bahwa kadang-kadang, tetapi tidak selalu, ketika Anda menekan Enter QGIS menggunakan tab alih-alih karakter spasi, artinya QGIS menambahkan kesalahan secara default. Meskipun saya tidak tahu kapan tepatnya itu tidak melakukannya dengan benar.
BritishSteel