differing-param-doc / W9017#
Message emitted:
"%s" differing in parameter documentation
Description:
Please check parameter names in declarations.
Problematic code:
def foo(x, y): # [differing-param-doc]
"""A dummy string.
:param int x: x value.
:param int z: z value.
"""
return x + y
Correct code:
def foo(x, y):
"""A dummy string.
:param int x: x value.
:param int y: y value.
"""
return x + y
Configuration file:
[MAIN]
load-plugins = pylint.extensions.docparams
Note
- This message is emitted by the optional 'parameter_documentation'
checker which requires the
pylint.extensions.docparams
plugin to be loaded.
Created by the parameter_documentation checker.