Comments (4)
I can't seem to reproduce the problem, can you give an example?
from docformatter.
@lordyavin can you confirm that your issue is given a docstring with the following whitespace
Summary line \n
\n
Elaborate description \n
docformatter will strip the whitespaces after "line" and "description", but will leave untouched the whitespace on the line between. It is this un-removed whitespace on the blank line that pycodestyle complains about. docformatter should strip the whitespaces on the blank line as well.
This would be an enhancement to docformatter since the whitespace in the blank line is PEP-257 compliant, but not PEP-8 compliant.
from docformatter.
I'm sorry, I don't have access to the sources that I edited when I opened this issue and currently I don't use python very much. So I can't confirm your analysis.
from docformatter.
It may depend on the interpretation of PEP-257, which says Multi-line docstrings consist of a summary line just like a one-line docstring, followed by a blank line,
together with The entire docstring is indented the same as the quotes at its first line (see example below).
.
As the example has no whitespaces in the blank line, the second statement is not in effect for "blank lines", and PEP-257 seems to prefer the whitespaces removed.
In any case, I agree that this will be an enhancement; I usually run pydocformatter after applying Black, and Black removes the whitespaces for me.
from docformatter.
Related Issues (20)
- release: v1.7.5 [Community Feedback]
- Useless trailing whitespace added
- Requirements table in docs does not actually render
- duplicate content after running docformatter HOT 2
- Inconsistent behavior with :arg syntax HOT 1
- Docformatter not formatting multi-line format of docstring
- ImportError: dlopen(/Users/glennjocher/.cache/pre-commit/repofadve4nf/py_env-python3.11/lib/python3.11/site-packages/charset_normalizer/md.cpython-311-darwin.so, 0x0002) HOT 4
- docformatter omits pyproject.toml configuration when has no extra dependencies installed
- I believe URL_REGEX is missing a `|` HOT 1
- pydocstyle: D202 - Removes blank line after function docstring.
- Incorrect handling of cvar, ivar and vartype tags in sphynx-style HOT 7
- Docstrings containing backticks are not formatted
- Tests fail with Python 3.12 HOT 1
- Bug: not splitting two sentence summary into description
- AttributeError: 'NoneType' object has no attribute 'encoding' (from_path(filename).best().encoding)
- Missing indentation as in example
- docformatter seems to have trouble with linebreaks inside directives in info fields HOT 3
- pre-commit hook usage is wrong in documentation
- docformatter 1.7.5 improperly breaks on emoji/formatted multiline string
- Multiple sentences in multi-line docstring summary
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docformatter.