docstrings/sphinx: Support "warn unknown params" feature

[pawamoy]

When a docstring is parsed, and a parameter is found, and the docstring has a parent function attached, we check that the parameter actually exists in the signature.

The following example should emit a warning:

def increment(a: int) -> int:
    """Increment a number.

    :param b: The number.
    """
    return a + 1

[Mohamed-Dhouioui]

I hope the following code would resolve the issue #64 :

if __name__ == '__main__': import warnings import inspect doc = inspect.getdoc(increment).split(":") params = [i.replace("param ", "") for i in doc if "param" in i else None] signature = inspect.signature(increment) for param in params: if param not in signature.parameters.keys(): warnings.warn('{} unknown param'.format(param))

[pawamoy]

Sorry @Mohamed-Dhouioui but that's really out of touch with the actual code.