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


9

Як я можу документувати власні функції Python у QGIS?

Я хотів би запропонувати користувачам допомогу щодо функцій, які я написав для них:

введіть тут опис зображення

Я спробував додати docstring:

введіть тут опис зображення

Але кожного разу, коли натискаю Завантажити , з’являється повідомлення про помилку:

введіть тут опис зображення

Повідомлення про помилку чітко показує помилку відступу, яка не відповідає моєму фактичному коду.

Відповіді:


8

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


@ nash має рацію. Я просто перевірив функцію, і помилка є лише при використанні простору вкладки замість 4 пробілів. +1, хороша відповідь!
mgri

Гарне мислення! Це означає, що і повідомлення про помилку є правильним. Дивно, що іноді, але не завжди, коли ви натискаєте Enter QGIS, використовується вкладка замість пробілів, тобто QGIS додає помилку за замовчуванням. Хоча я не можу зрозуміти, коли саме це не робиться правильно.
BritishSteel
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.