darglint
darglint copied to clipboard
DAR103 on built in types and modules parameters with backticks (``) surrounding them
Summary
When using backticks (``) on parameter type for built in type parameters (str, int, list...) and modules (os, re...), the DAR103 error is shown. This doesn't happen with module classes (os.DirEntry, re.Match...).
Is this working as expected? Or is this a bug?
Reproduction
- Create a
demo.pyfile with the following content
async def foo(
param1: os.DirEntry, # any random class
param2: str,
) -> None:
"""
Description here
Parameters
----------
param1 : `os.DirEntry`
param1 description.
param2 : `str`
param2 description.
"""
- Execute
darglint -s numpy demo.py
Expected result
No errors reported by darglint or errors reported in both parameters.
Actual result
This error is shown by darlint:
demo.py:foo:9: DAR103: ~param2: expected str but was `str`
Versions used
darglint 1.8.1 Python 3.10.2