darglint icon indicating copy to clipboard operation
darglint copied to clipboard

keywords argument support

Open trim21 opened this issue 6 years ago • 0 comments

according to sphinx document(search napoleon_use_param)


def func(a, b, **kwargs):
    """example function
    :param a: parameter a
    :param b: parameter b
    :keyword arguments: * **arg1** (*str*) --
               Description of `arg1`
             * **arg2** (*int, optional*) --
               Description of `arg2`, defaults to 0
    """
    pass
darglint tmp/a.py
tmp/a.py:func:8: DAR101: - **kwargs

And, I think it should be :param kwargs: description instead of :param **kwargs: description darglint trade second one as correct doc

trim21 avatar Oct 26 '19 14:10 trim21