QGIS에서 커스텀 파이썬 함수 문서화


9

QGIS에서 커스텀 파이썬 함수를 어떻게 문서화 할 수 있습니까?

내가 작성한 기능에 대한 도움말을 사용자에게 제공하고 싶습니다.

여기에 이미지 설명을 입력하십시오

docstring을 추가하려고했습니다.

여기에 이미지 설명을 입력하십시오

그러나 로드를 클릭 할 때마다 오류 메시지가 표시됩니다.

여기에 이미지 설명을 입력하십시오

오류 메시지에는 들여 쓰기 오류가 명확하게 표시되어 실제 코드와 일치하지 않습니다.

답변:


8

당신이하고있는 일은 사용자 정의 기능을 문서화하는 올바른 방법입니다.
발생하는 오류는 기본적으로 함수 편집기 에서 함수를 작성할 때 return명령문 앞의 들여 쓰기 는 '탭 스페이스'가 아닌 4 개의 공백 문자 이기 때문에 발생 합니다. 그런 경우인지 확인하십시오. 들여 쓰기는 일관성이 있어야합니다 (공백 또는 탭 공간).


@ nash가 맞습니다. 방금 함수를 테스트했으며 4 개의 공백 대신 탭 공간을 사용할 때만 오류가 발생합니다. +1, 좋은 답변입니다!
mgri

좋은 생각이야! 이는 오류 메시지도 올바른 것을 의미합니다. Enter QGI를 누를 때 가끔은 아니지만 항상 QGIS가 공백 문자 대신 탭을 사용하는 것이 이상합니다. 이는 QGIS가 기본적으로 오류를 추가한다는 것을 의미합니다. 정확히 올바르게 수행하지 않으면 알아낼 수 없지만.
BritishSteel
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.