-
Notifications
You must be signed in to change notification settings - Fork 86
Labels
C: styleRelates to docstring format style (e.g., Google, NumPy, Sphinx)Relates to docstring format style (e.g., Google, NumPy, Sphinx)P: bugPEP 257 violation or existing functionality that doesn't work as documentedPEP 257 violation or existing functionality that doesn't work as documentedU: mediumA relatively medium urgency issueA relatively medium urgency issue
Description
With v1.7.1, some newlines are being removed between :raises : and :param : documentation.
@@ -3,7 +3,6 @@ def search_delete(self, search_id=None, **kwargs):
Delete a search job.
:raises NotFound404Error:
-
:param search_id: ID of search to delete
:return: None
"""Although, this one is not reformatted:
def rss_mark_as_read(self, item_path=None, article_id=None, **kwargs):
"""
Mark RSS article as read. If article ID is not provider, the entire feed is marked
as read.
:raises NotFound404Error:
:param item_path: path to item to be refreshed (e.g. ``Folder\\Subfolder\\ItemName``)
:param article_id: article ID from :meth:`~RSSAPIMixIn.rss_items`
:return: None
"""Config:
- repo: https://github.com/PyCQA/docformatter
rev: v1.7.1
hooks:
- id: docformatter
args: [--in-place, --pre-summary-newline, --black]more examples: rmartin16/qbittorrent-api#210
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
C: styleRelates to docstring format style (e.g., Google, NumPy, Sphinx)Relates to docstring format style (e.g., Google, NumPy, Sphinx)P: bugPEP 257 violation or existing functionality that doesn't work as documentedPEP 257 violation or existing functionality that doesn't work as documentedU: mediumA relatively medium urgency issueA relatively medium urgency issue