Documentation des fonctions Python personnalisées dans QGIS

Comment puis-je documenter mes fonctions Python personnalisées dans QGIS?

Je voudrais offrir aux utilisateurs de l'aide pour les fonctions que j'ai écrites pour eux:

J'ai essayé d'ajouter une docstring:

Mais chaque fois que je clique sur Charger, un message d'erreur s'affiche:

Le message d'erreur montre clairement une erreur d'indentation, qui ne correspond pas à mon code réel.

— BritishSteel
source

Ce que vous faites est la bonne façon de documenter votre fonction personnalisée.
L'erreur que vous rencontrez est parce que par défaut lorsque vous écrivez une fonction dans l' éditeur de fonctions , l'indentation avant l' returninstruction est celle de 4 espaces et non pas de «tabulation». Vérifiez simplement si c'est le cas. L'indentation doit être cohérente (uniquement des espaces ou des tabulations).

— nash
source

@ nash a raison. Je viens de tester la fonction et il n'y a une erreur que lors de l'utilisation d'un espace de tabulation au lieu de 4 espaces. +1, bonne réponse!

— mgri

Bien pensé! Cela signifie que le message d'erreur est également correct. Il est étrange que parfois, mais pas toujours, lorsque vous appuyez sur Entrée, QGIS utilise un onglet au lieu de caractères d'espace, ce qui signifie que QGIS ajoute une erreur par défaut. Bien que je ne puisse pas savoir exactement quand il ne le fait pas correctement.

— BritishSteel