Skip to content

Commit

Permalink
Switch to pprint for Doc objects
Browse files Browse the repository at this point in the history
  • Loading branch information
jsh9 committed Jun 26, 2024
1 parent bf674fa commit 457a559
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 1 deletion.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Change Log

## [unpublished]

- Changed
- Pinned to a higher version (0.0.9) of docstring_parser_fork

## [0.5.1] - 2024-06-24

- Fixed
Expand Down
4 changes: 4 additions & 0 deletions pydoclint/utils/doc.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import pprint
from typing import Any, List

from docstring_parser.common import (
Expand Down Expand Up @@ -33,6 +34,9 @@ def __init__(self, docstring: str, style: str = 'numpy') -> None:
else:
self._raiseException()

def __repr__(self) -> str:
return pprint.pformat(self.__dict__, indent=2)

@property
def isShortDocstring(self) -> bool:
"""Is the docstring a short one (containing only a summary)"""
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ classifiers =
packages = find:
install_requires =
click>=8.1.0
docstring_parser_fork>=0.0.8
docstring_parser_fork>=0.0.9
tomli>=2.0.1; python_version<'3.11'
python_requires = >=3.8

Expand Down

0 comments on commit 457a559

Please sign in to comment.