Skip to content

Commit

Permalink
Update dependency to fix return section parsing (#90)
Browse files Browse the repository at this point in the history
  • Loading branch information
jsh9 authored Oct 18, 2023
1 parent 38ae4c6 commit ef6dc07
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 2 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand Down
12 changes: 12 additions & 0 deletions tests/data/edge_cases/08_return_section_parsing/google.py
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions tests/test_main.py
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down

0 comments on commit ef6dc07

Please sign in to comment.