Si encuentras algún problema con tu código o trabajo, recuerda probar siempre en un ambiente de testing antes aplicar el código al proyecto final.
Solución:
Es bueno que un módulo de Python tenga una cadena de documentación que explique qué hace el módulo, qué proporciona, ejemplos de cómo usar las clases. Esto es diferente de los comentarios que a menudo ve al comienzo de un archivo que brinda la información de derechos de autor y licencia, que en mi opinión no deberían ir en la cadena de documentación (algunos incluso argumentan que deberían desaparecer por completo, consulte, por ejemplo, Deshágase de las plantillas de código fuente)
Con Pylint 2.4 y superior, puede diferenciar entre los distintos missing-docstring utilizando los tres submensajes siguientes:
C0114(missing-module-docstring)C0115(missing-class-docstring)C0116(missing-function-docstring)
Entonces lo siguiente .pylintrc el archivo debería funcionar:
[MASTER]
disable=
C0114, # missing-module-docstring
Para versiones anteriores de Pylint, no tiene un código separado para los distintos lugares donde pueden ocurrir cadenas de documentos, por lo que todo lo que puede hacer es deshabilitar C0111. El problema es que si deshabilita esto en el alcance del módulo, se deshabilitará en todas partes del módulo (es decir, no obtendrá ninguna línea C para la cadena de documentación de función/clase/método faltante. Lo que podría decirse que no es agradable.
Así que sugiero agregar esa pequeña cadena de documentación faltante, diciendo algo como:
"""
high level support for doing this and that.
"""
Muy pronto, encontrará cosas útiles para poner allí, como proporcionar ejemplos de cómo usar las diversas clases/funciones del módulo que no necesariamente pertenecen a las cadenas de documentos individuales de las clases/funciones (como cómo estos interactuar, o algo así como una guía de inicio rápido).
Encontré esto aquí.
Puede agregar el indicador “–errors-only” para que Pylint deshabilite las advertencias.
Para hacer esto, vaya a la configuración. Edite la siguiente línea:
"python.linting.pylintArgs": []
Como
"python.linting.pylintArgs": ["--errors-only"]
¡Y estás listo para irte!
Creo que la solución es relativamente fácil sin deshabilitar esta función.
def kos_root():
"""Return the pathname of the KOS root directory."""
global _kos_root
if _kos_root: return _kos_root
Todo lo que necesita hacer es agregar las comillas dobles triples string en cada función.
Agradecemos que quieras defender nuestra labor mostrando un comentario o valorándolo te damos las gracias.