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.

Sign up for GitHub

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

Jump to bottom

Explain why black avoids using \ for code organization #392

Closed
zsol opened this issue Jul 2, 2018 · 3 comments · Fixed by #1399
Closed

Explain why black avoids using \ for code organization #392

zsol opened this issue Jul 2, 2018 · 3 comments · Fixed by #1399
Labels
good first issue Good for newcomers help wanted Extra attention is needed T: documentation Improvements to the docs (e.g. new topic, correction, etc)

Comments

@zsol
Copy link
Collaborator

zsol commented Jul 2, 2018

The README should have a clear, concise explanation for why black avoids using \.

Here's a lengthy reasoning 👀
@zsol zsol added help wanted Extra attention is needed good first issue Good for newcomers T: documentation Improvements to the docs (e.g. new topic, correction, etc) labels Jul 2, 2018
@zsol zsol mentioned this issue Jul 2, 2018
Closed
@sudheer-g
Copy link

Hey! I've read @ambv 's explanation on this. Is it okay if I give this a shot? Thanks.

@ambv
Copy link
Collaborator

ambv commented Oct 10, 2018

Of course, go for it!

@sudheer-g sudheer-g mentioned this issue Oct 10, 2018
Closed
@ambv
Copy link
Collaborator

ambv commented Mar 3, 2020

Wording to use:

Backslashes are one of the two places in the Python grammar that break significant indentation. The other one is multiline strings. You never need backslashes, they are used to force the grammar to accept breaks that would otherwise be parse errors. That makes them confusing to look at and brittle to modify. This is why Black always gets rid of them.

If you're reaching for backslashes, that's a clear signal that you can do better if you slightly refactor your code. I hope some of the examples above show you that there are many ways in which you can do it.

However, there will be one exception: with statements with multiple context managers: #664

@SanketDG SanketDG mentioned this issue May 9, 2020
Merged
cooperlees pushed a commit that referenced this issue May 9, 2020
@SanketDG
Add preference of parantheses over backslashes in docs (#1399)
f6393a2 
Closes #392

Revived from #558

Relevant to #664
Kumljevx1 added a commit to Kumljevx1/black that referenced this issue Aug 26, 2024
@Kumljevx1
Add preference of parantheses over backslashes in docs (#1399)
95d7edc 
Closes psf/black#392

Revived from psf/black#558

Relevant to psf/black#664
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers help wanted Extra attention is needed T: documentation Improvements to the docs (e.g. new topic, correction, etc)
Projects
None yet
Milestone
No milestone
3 participants
@ambv @zsol @sudheer-g