pydoclint: Optional arguments false positive
Both of these examples trigger an error DOC105: Function test: Argument names match, but type hints do not match
:
def test(var1: Optional[str] = None) -> str:
"""Test function.
Args:
var1 (str, optional): var1
Returns:
str
"""
def test(var1: str | None = None) -> str:
"""Test function.
Args:
var1 (str, optional): var1
Returns:
str
"""
Changing the var1 type to str | None
solves it, but this is a bit redundant and, as far as I know, inconsistent with how most other tools work. You can see for example the function module_level_function
from Sphinx napoleon documentation.
About this issue
- Original URL
- State: closed
- Created a year ago
- Comments: 20 (16 by maintainers)
A bit hacky, but can probably be improved and certainly more robust/generic than just ignoring spaces: