Skip to content

Commit 0d7f497

Browse files
enabled pydocstyle
1 parent 4e6ef19 commit 0d7f497

File tree

3 files changed

+12
-5
lines changed

3 files changed

+12
-5
lines changed

Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,12 @@ auto-style: ## Style the code
6262
else echo "SKIPPED. Run '$(PIP) install black' first." >&2 ; fi
6363

6464
code-style: ## Test the code style
65-
@echo PyCodestyle...
65+
@echo Pycodestyle...
6666
@if type pycodestyle >/dev/null 2>&1 ; then pycodestyle $(SRC_CORE) ; \
6767
else echo "SKIPPED. Run '$(PIP) install pycodestyle' first." >&2 ; fi
68+
@echo Pydocstyle...
69+
@if type pydocstyle >/dev/null 2>&1 ; then pydocstyle $(SRC_CORE) ; \
70+
else echo "SKIPPED. Run '$(PIP) install pydocstyle' first." >&2 ; fi
6871

6972
code-count: ## Count the code
7073
@if type cloc >/dev/null 2>&1 ; then cloc $(SRC_CORE) ; \

setup.cfg

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ version = attr: things_cli.__version__
55
max_line_length = 88
66
ignore = E501,E203,W503
77

8+
[pydocstyle]
9+
ignore = D202,D203
10+
811
[flake8]
912
max-line-length = 88
1013
max-complexity = 10

things_cli/cli.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ class ThingsCLI: # pylint: disable=R0902
3434
filter_tag = None
3535

3636
def __init__(self, database=None):
37+
"""Initialize class."""
3738
self.database = database
3839

3940
def print_tasks(self, tasks):
@@ -138,7 +139,7 @@ def print_unimplemented(cls, command):
138139

139140
@classmethod
140141
def get_parser(cls):
141-
"""Create command line argument parser"""
142+
"""Create command line argument parser."""
142143
parser = argparse.ArgumentParser(description="Simple read-only Thing 3 CLI.")
143144

144145
subparsers = parser.add_subparsers(
@@ -282,7 +283,7 @@ def get_parser(cls):
282283
return parser
283284

284285
def defaults(self):
285-
"""Some default options for the new API."""
286+
"""Set default options for the new API."""
286287
return dict(
287288
project=self.filter_project,
288289
area=self.filter_area,
@@ -292,7 +293,7 @@ def defaults(self):
292293
)
293294

294295
def main(self, args=None):
295-
""" Main entry point of the app """
296+
"""Start the main app."""
296297

297298
if args is None:
298299
self.main(ThingsCLI.get_parser().parse_args())
@@ -360,7 +361,7 @@ def main(self, args=None):
360361

361362

362363
def main():
363-
"""Main entry point for CLI installation"""
364+
"""Start for CLI installation."""
364365
ThingsCLI().main()
365366

366367

0 commit comments

Comments
 (0)