Documentare le funzioni personalizzate di Python in QGIS

Come posso documentare le mie funzioni Python personalizzate in QGIS?

Vorrei offrire agli utenti un aiuto per le funzioni che ho scritto per loro:

Ho provato ad aggiungere un docstring:

Ma ogni volta che faccio clic su Carica viene visualizzato un messaggio di errore:

Il messaggio di errore mostra chiaramente un errore di rientro, che non corrisponde al mio codice attuale.

— BritishSteel
fonte

Quello che stai facendo è il modo corretto di documentare la tua funzione personalizzata.
L'errore che stai riscontrando è perché di default quando scrivi una funzione nell'editor di funzioni , il rientro prima dell'istruzione returnè quello di 4 spazi e non "spazio tab". Controlla se è così. Il rientro deve essere coerente (solo spazi o tabulazioni).

— nash
fonte

@ nash ha ragione. Ho appena testato la funzione e c'è un errore solo quando si utilizza uno spazio di tabulazione invece di 4 spazi. +1, buona risposta!

— mgri

Pensare bene! Ciò significa che anche il messaggio di errore è corretto. È strano che a volte, ma non sempre, quando si preme Invio QGIS utilizza una scheda anziché i caratteri dello spazio, il che significa che QGIS aggiunge un errore per impostazione predefinita. Anche se non riesco a capire quando esattamente non lo fa correttamente.

— BritishSteel