짧은 함수 및 메서드에 대한 docstring 오류가 pylint에 없음을 해제 할 수 있습니까?

Question

Pylint는 docstring이없는 모든 함수와 메서드 (__init__ 제외)에 대해 오류를보고합니다.

일반적으로 바람직하지 않으므로 전역으로 사용하지 않도록 설정합니다 (pylintrc 또는 파일 수준).

그러나 내 견해로는 문서화 문자열이 필요없고 심지어 유해한 경우가 있습니다. 예를 들면 다음과 같습니다.

def get_foo(self, foo_id): 
    """Gets foo by its id."""" 
    return foos[foo_id] 

이 메서드는 서명에 의해 완전히 설명되는 간단한 getter입니다. 문서화 문자열을 작성하는 것은 메소드가 변경된 경우 중복 유지 보수를 작성한다는 점에서 해를 끼친다.

docstring_threshold=3과 같은 것을 설정하여 함수 또는 메소드가 3 줄의 코드보다 짧으면 누락 된 docstring 오류를 방지 할 수 있습니다. 그것을 할 방법이 있습니까?

Answer 1

pylint 1.3.1을 사용하면 pylintrc docstring-min-length=10과 같은 줄을 추가 할 수 있습니다.

그것은 기능/문서화 문자열을 필요로 클래스

최소 선 길이로 생성 된 pylintrc pylint --generate-rcfile 파일에 설명되어 짧은 사람은 면제됩니다.

Documentation reference.