Документирование пользовательских функций Python в QGIS

Как я могу документировать свои пользовательские функции Python в QGIS?

Я хотел бы предложить пользователям помощь для функций, которые я написал для них:

Я попытался добавить строку документации:

Но всякий раз, когда я нажимаю « Загрузить», отображается сообщение об ошибке:

Сообщение об ошибке ясно показывает ошибку отступа, которая не соответствует моему фактическому коду.

То, что вы делаете, - это правильный способ документировать вашу пользовательскую функцию.
Ошибка, с которой вы сталкиваетесь, заключается в том, что по умолчанию, когда вы пишете функцию в редакторе функций , перед returnоператором делается отступ, состоящий из 4 пробелов, а не «пробела». Просто проверьте, так ли это. Отступы должны быть единообразными (либо только пробелы, либо пробелы).

— Нэш
источник

@ Нэш прав. Я только что протестировал функцию, и возникает ошибка только при использовании пробела вместо 4 пробелов. +1, хороший ответ!

— Мгри

Хорошая мысль! Это означает, что сообщение об ошибке также является правильным. Странно, что иногда, но не всегда, когда вы нажимаете Enter, QGIS использует символ пробела вместо пробелов, что означает, что QGIS добавляет ошибку по умолчанию. Хотя я не могу понять, когда именно он не делает это правильно.

— BritishSteel