Comments (3)
I think this should be fairly simple as (other than parameters) only _format_code()
need be modified. Feel free to send a pull request.
from docformatter.
By the way, you might have seen this already by now, but there is a nice checker for PEP 257.
https://github.com/GreenSteam/pep257
from docformatter.
You're right this is pretty trivial :) , just a slight question of what the rule set should be... The easiest, and this seems reasonable to me, would be to fix the entire doc string if any of the docstring were contained in the line range... sound ok?
from docformatter.
Related Issues (20)
- 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
- Differing behavior between linux and macos
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.