Skip to content

Commit

Permalink
fix docstring + fix [docformatter] section to correctly detect and us…
Browse files Browse the repository at this point in the history
…e setup.cfg config (relates to PyCQA/docformatter#112)
  • Loading branch information
fmigneault committed Aug 20, 2022
1 parent 420e0da commit 548569c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
8 changes: 4 additions & 4 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -95,16 +95,16 @@ exclude =
max-line-length = 120
ignore-path = docs/build,docs/source/autoapi

[tool.docformatter]
recursive = true
# NOTE:
# Don't employ 'wrap-descriptions = 120' since they *enforce* that length and rearranges format if any word can fit
# within remaining space, which often cause big diffs of ugly formatting for no important reason. Instead only check
# general formatting operations, and let other linter capture docstrings going over 120 (what we really care about).
[docformatter]
recursive = true
wrap-descriptions = 0
wrap-summaries = 120
make-summary-multi-line = true
pre-summary-newline = true
make-summary-multi-line = True
pre-summary-newline = True

[pydocstyle]
add_ignore = D100,D101,D102,D103,D104,D105,D107,D200,D202,D204,D212,D401
Expand Down
2 changes: 2 additions & 0 deletions tests/wps_restapi/test_jobs.py
Original file line number Diff line number Diff line change
Expand Up @@ -1223,6 +1223,8 @@ def test_get_job_status_response_process_id(self):

def test_get_job_invalid_uuid(self):
"""
Test handling of invalid UUID reference to search job.
.. versionchanged:: 4.6.0
Jobs must explicitly use an :class:`uuid.UUID` object to search.
Any value provided in path parameter that does not correspond to such definition raises a bad request.
Expand Down

0 comments on commit 548569c

Please sign in to comment.