Skip to content

Commit

Permalink
Add dot at the end of the docstring following pep257
Browse files Browse the repository at this point in the history
Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
  • Loading branch information
Pierre-Sassoulas and DanielNoord committed Jan 4, 2022
1 parent 64774ee commit f4cd08c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions pydocstringformatter/formatting/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@


class Formatter:
"""Base class for docstring formatter"""
"""Base class for docstring formatter."""

@abc.abstractmethod
def treat_token(self, tokeninfo: tokenize.TokenInfo) -> tokenize.TokenInfo:
"""Return a modified token"""
"""Return a modified token."""


class StringFormatter(Formatter):
"""Base class for formatter that only modifies the string content"""
"""Base class for formatter that only modifies the string content."""

@abc.abstractmethod
def _treat_string(self, tokeninfo: tokenize.TokenInfo) -> str:
"""Return a modified string"""
"""Return a modified string."""

def treat_token(self, tokeninfo: tokenize.TokenInfo) -> tokenize.TokenInfo:
return tokenize.TokenInfo(
Expand Down

0 comments on commit f4cd08c

Please sign in to comment.