QGIS'de özel Python işlevlerini belgeleme

QGIS'de özel Python işlevlerimi nasıl belgeleyebilirim?

Kullanıcılara onlar için yazdığım işlevler için yardım sunmak istiyorum:

Bir docstring eklemeyi denedim:

Ancak Yükle'yi tıklattığımda bir Hata mesajı görüntüleniyor:

Hata mesajı, gerçek koduma karşılık gelmeyen bir girinti hatasını açıkça gösteriyor.

— BritishSteel
kaynak

Yaptığınız şey özel işlevinizi belgelemenin doğru yoludur.
Karşılaştığınız hata, varsayılan olarak İşlev Düzenleyicisi'ne bir işlev yazdığınızda , returnifadeden önceki girintinin 'sekme alanı' değil 4 boşluk karakteri olmasıdır. Sadece durumun böyle olup olmadığını kontrol edin. Girinti tutarlı olmalıdır (yalnızca boşluklar veya sekme alanı).

— nash
kaynak

@ nash haklı. Sadece işlevi test ettim ve sadece 4 boşluk yerine bir sekme alanı kullanırken bir hata var. +1, iyi cevap!

— mgri

İyi düşünmek! Bu, hata mesajının da doğru olduğu anlamına gelir. QGIS Enter tuşuna bastığınızda bazen her zaman olmasa da bazen gariptir, yani boşluk karakterleri yerine bir sekme kullanır, bu da QGIS'in varsayılan olarak bir hata eklediği anlamına gelir. Her ne kadar tam olarak doğru bir şekilde yapmadığını anlayamıyorum.

— İngilizSteel