Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for different line-wrapping conventions: no two sentences on the same line #123

Open
tovrstra opened this issue Oct 19, 2022 · 0 comments
Labels
C: stakeholder Relates to docformatter stakeholder requested behavior P: enhancement Feature that is outside the scope of PEP 257 U: low A relatively low urgency issue
Milestone

Comments

@tovrstra
Copy link

The following would be nice to have as an option: only wrap long lines, but do not join two subsequent sentences into one line.

For example:

This is a first sentence.
This is another long sentence, which should not be joined to the
previous one.

Having each sentence on its own line(s) makes it easier to visualize changes in text with git diff.
Otherwise, one small change in a long paragraph may cause many lines to be affected due to rewrapping of subsequent sentences, which makes the git diff output harder to process.

The each-sentence-on-its-own-line convention is something I got used to by working on LaTeX projects in Git, but it is such a nice improvement over rewrapping (manual or automatic), that I started using it in docstrings and markdown files as well.

I can imagine this would not be the preferred convention for everyone, but I would certainly use it, if it were an option.

@github-actions github-actions bot added the fresh This is a new issue label Oct 19, 2022
@weibullguy weibullguy added P: enhancement Feature that is outside the scope of PEP 257 C: stakeholder Relates to docformatter stakeholder requested behavior and removed fresh This is a new issue labels Nov 7, 2022
@weibullguy weibullguy added the V: minor Bumps the minor version label Dec 16, 2022
@weibullguy weibullguy removed the V: minor Bumps the minor version label Jan 19, 2023
@weibullguy weibullguy added this to the v2.0.0 milestone Jan 23, 2023
@weibullguy weibullguy added P: enhancement Feature that is outside the scope of PEP 257 and removed P: enhancement Feature that is outside the scope of PEP 257 labels Jun 7, 2023
@github-actions github-actions bot added the U: low A relatively low urgency issue label Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: stakeholder Relates to docformatter stakeholder requested behavior P: enhancement Feature that is outside the scope of PEP 257 U: low A relatively low urgency issue
Projects
None yet
Development

No branches or pull requests

2 participants