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

Outdated documentation for isort compatibility #3565

Closed
mitchnegus opened this issue Feb 12, 2023 · 1 comment · Fixed by #3567
Closed

Outdated documentation for isort compatibility #3565

mitchnegus opened this issue Feb 12, 2023 · 1 comment · Fixed by #3567
Labels
C: integrations Editor plugins and other integrations F: linebreak How should we split up lines? T: documentation Improvements to the docs (e.g. new topic, correction, etc)

Comments

@mitchnegus
Copy link
Contributor

Is this related to a problem? Please describe.

I believe that the documentation for compatibility with isort may be outdated. The Why those options above? section states:

Black wraps imports that surpass line-length by moving identifiers into their own indented line. If that still doesn’t fit the bill, it will put all of them in separate lines and put a trailing comma.

In my experience (and supported by this old conversation), its seems that Black no longer makes a first attempt to move identifiers to their own indented line, and it just defaults to newlines for each (with trailing commas).

Describe the solution you'd like

Assuming I'm not misunderstanding something, the documentation should probably be updated to reflect this chanage. I think the following wording might suffice:

Black wraps imports that surpass line-length by moving identifiers onto separate lines and by adding a trailing comma after each.

I'm happy to submit the MR with that change if this checks out. (PS: thanks for an awesome tool!)

@mitchnegus mitchnegus added the T: documentation Improvements to the docs (e.g. new topic, correction, etc) label Feb 12, 2023
@ichard26 ichard26 added C: integrations Editor plugins and other integrations F: linebreak How should we split up lines? labels Feb 12, 2023
@ichard26
Copy link
Collaborator

Huh, I didn't know this until now. A MR would be welcomed! Thanks for reporting!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: integrations Editor plugins and other integrations F: linebreak How should we split up lines? T: documentation Improvements to the docs (e.g. new topic, correction, etc)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants