python - ¿Es posible deshabilitar el error docstring faltante de pylint para funciones y métodos cortos?

coding-style

Question

Pylint informa un error para cada función y método (excepto __init__ ) que no tiene ninguna cadena de documentación.

Esto es generalmente deseable, así que no quiero deshabilitarlo globalmente (en pylintrc o a nivel de archivo).

Sin embargo, en mi opinión, hay casos en que una cadena de documentación no es necesaria, e incluso perjudicial. Por ejemplo:

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

Este método es un captador simple que está completamente descrito por su firma. Tener que escribir una cadena de documentos es perjudicial porque crea un mantenimiento duplicado si se cambia el método.

Me gustaría poder establecer (por ejemplo, en pylintrc ) algo como docstring_threshold=3 , para eliminar los errores faltantes de docstring si la función o el método es más corto que 3 líneas de código. ¿Hay alguna forma de hacer eso?

Answer 1

Usando pylint 1.3.1, agregue una línea a su pylintrc docstring-min-length=10 por ejemplo.

Se describe en el archivo pylint --generate-rcfile como

Longitud de línea mínima para funciones / clases que requieren cadenas de documentación, las más cortas están exentas.

Referencia de la documentación .