diff --git a/CHANGELOG.md b/CHANGELOG.md index eb9a728..914f99a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Change Log +## [0.3.6] - 2023-10-18 + +- Fixed + + - Updated dependency (docstring_parser_fork) to 0.0.5 to fix issues when + parsing Google-style return section + +- Full diff + - https://github.com/jsh9/pydoclint/compare/0.3.5...0.3.6 + ## [0.3.5] - 2023-10-17 - Changed diff --git a/setup.cfg b/setup.cfg index 334b576..7789dee 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = pydoclint -version = 0.3.5 +version = 0.3.6 description = A Python docstring linter that checks arguments, returns, yields, and raises sections long_description = file: README.md long_description_content_type = text/markdown @@ -16,7 +16,7 @@ classifiers = packages = find: install_requires = click>=8.0.0 - docstring_parser_fork>=0.0.4 + docstring_parser_fork>=0.0.5 tomli>=2.0.1; python_version<'3.11' python_requires = >=3.8 diff --git a/tests/data/edge_cases/08_return_section_parsing/google.py b/tests/data/edge_cases/08_return_section_parsing/google.py new file mode 100644 index 0000000..1f7f5ef --- /dev/null +++ b/tests/data/edge_cases/08_return_section_parsing/google.py @@ -0,0 +1,12 @@ +from typing import Any + + +def test_function() -> dict[str, Any] | None: + """Some function + + This edge case comes from: https://github.com/jsh9/pydoclint/issues/84 + + Returns: + dict[str, Any] | None: Something + """ + pass diff --git a/tests/test_main.py b/tests/test_main.py index 9d36779..c796612 100644 --- a/tests/test_main.py +++ b/tests/test_main.py @@ -1111,6 +1111,7 @@ def testNonAscii() -> None: 'Arguments in the function signature but not in the docstring: [c: list].', ], ), + ('08_return_section_parsing/google.py', {'style': 'google'}, []), ], ) def testEdgeCases(