Skip to content

Update pydocstringformatter to 0.5.2 #75

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.

Sign up for GitHub

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

Merged
Pierre-Sassoulas merged 3 commits into from
Mar 15, 2022
Merged

Update pydocstringformatter to 0.5.2 #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
30504b8
Update ``pydocstringformatter`` to ``0.5.2``
DanielNoord Mar 15, 2022
0d4bd65
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 15, 2022
c86775a
Update docstring
DanielNoord Mar 15, 2022
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
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ repos:
additional_dependencies:
[pytest-stub==1.1.0, types-docutils~=0.17.5, sphinx~=4.4]
- repo: https://github.com/DanielNoord/pydocstringformatter
rev: v0.5.0
rev: v0.5.2
hooks:
- id: pydocstringformatter
exclude: *test-data
Expand Down
4 changes: 1 addition & 3 deletions tests/test_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,7 @@ def test_function_docstrings(self) -> None:
]

def test_dictionary_key_value_line(self) -> None:
"""Test that we do not classify a line of string key and value pairs
as docstring
"""
"""Test that string key-value pairs are not considered a docstring."""
docstrings: List[Tuple[Tuple[int, int], Tuple[int, int]]] = []
with open(self.docstring_data / "dictionary.py", encoding="utf-8") as file:
tokens = list(tokenize.generate_tokens(file.readline))
Expand Down