-
Notifications
You must be signed in to change notification settings - Fork 86
Closed
Labels
C: conventionRelates to docstring format conventionRelates to docstring format conventionP: bugPEP 257 violation or existing functionality that doesn't work as documentedPEP 257 violation or existing functionality that doesn't work as documentedU: high
Description
Hi! βπ»
The package is great! Thanks a lot for contributing! π₯
I have been using it for while and recently noticed that the tool ignores the docstrings containing "backticks" (the ones used e.g. to markup inline code in GitHub markdown).
My configuration (pyproject.toml) is:
[tool.docformatter]
black = true
blank = true
close-quotes-on-newline = true
make-summary-multi-line = true
recursive = true
pre-summary-newline = true
Sample code:
def foo(bar):
"""Return `foo` using `bar`. Description."""is not formatted (neither via CLI nor pre-commit hook). If I replace backticks to single quotation marks, everything works as expected, namely I get the following diff.:
--- before/./test.py
+++ after/./test.py
@@ -12,4 +12,9 @@
def foo(bar):
- """Return 'foo' using 'bar'. Description."""
+ """
+ Return 'foo' using 'bar'.
+
+ Description.
+
+ """
Any ideas? Thanks! π€
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
C: conventionRelates to docstring format conventionRelates to docstring format conventionP: bugPEP 257 violation or existing functionality that doesn't work as documentedPEP 257 violation or existing functionality that doesn't work as documentedU: high