Documentando funções personalizadas do Python no QGIS

Como posso documentar minhas funções personalizadas do Python no QGIS?

Gostaria de oferecer aos usuários ajuda para as funções que escrevi para eles:

Eu tentei adicionar uma docstring:

Mas sempre que eu clicar em Carregar, uma mensagem de erro será exibida:

A mensagem de erro mostra claramente um erro de recuo, que não corresponde ao meu código real.

— BritishSteel
fonte

O que você está fazendo é a maneira correta de documentar sua função personalizada.
O erro que você encontra é porque, por padrão, quando você escreve uma função no Editor de Funções , o recuo antes da returninstrução é o de 4 caracteres de espaços e não o 'espaço de tabulação'. Basta verificar se é esse o caso. O recuo deve ser consistente (apenas espaços ou espaço de tabulação).

— nash
fonte

@ nash está certo. Acabei de testar a função e há um erro apenas ao usar um espaço de tabulação em vez de quatro espaços. +1, boa resposta!

— MGRI

Bem pensado! Isso significa que a mensagem de erro também está correta. É estranho que às vezes, mas nem sempre, quando você pressiona Enter, o QGIS usa uma guia em vez de caracteres de espaço, o que significa que o QGIS adiciona um erro por padrão. Embora eu não consiga descobrir quando exatamente isso não acontece corretamente.

— precisa