Documentar funciones personalizadas de Python en QGIS

9

¿Cómo puedo documentar mis funciones personalizadas de Python en QGIS?

Me gustaría ofrecer ayuda a los usuarios para las funciones que escribí para ellos:

ingrese la descripción de la imagen aquí

Intenté agregar una cadena de documentación:

ingrese la descripción de la imagen aquí

Pero cada vez que hago clic en Cargar aparece un mensaje de error:

ingrese la descripción de la imagen aquí

El mensaje de error muestra claramente un error de sangría, que no corresponde a mi código real.

BritishSteel
fuente

Respuestas:

8

Lo que está haciendo es la forma correcta de documentar su función personalizada.
El error con el que se encuentra se debe a que, de manera predeterminada, cuando escribe una función en el Editor de funciones , la sangría antes de la returndeclaración es la de 4 espacios y no 'espacio de tabulación'. Solo verifique si ese es el caso. La sangría debe ser consistente (ya sea solo espacios o espacio de tabulación).

nash
fuente
@ nash tiene razón. Acabo de probar la función y hay un error solo cuando utilizo un espacio de tabulación en lugar de 4 espacios. +1, buena respuesta!
mgri
¡Buen pensamiento! Esto significa que el mensaje de error también es correcto. Es extraño que a veces, pero no siempre, cuando presiona Enter QGIS use una pestaña en lugar de caracteres de espacio, lo que significa que QGIS agrega un error por defecto. Aunque no puedo entender cuándo exactamente no lo hace correctamente.
BritishSteel