Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dependency to fix return section parsing #90

Merged
merged 8 commits into from
Oct 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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