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

Add black formatter #1498

Closed
cognifloyd opened this issue Mar 18, 2022 · 2 comments · Fixed by #1539
Closed

Add black formatter #1498

cognifloyd opened this issue Mar 18, 2022 · 2 comments · Fixed by #1539
Milestone

Comments

@cognifloyd
Copy link
Contributor

Description

I use black in a lot of open source projects. When reviewing the code here, it would be nice to have the same format.

There is going to be a lot of PRs involved in the major rewrite of #1489. Could we reformat with black before all of that happens? Or somewhere convenient in the process?

@RobbeSneyders
Copy link
Member

RobbeSneyders commented Mar 18, 2022

Hi @cognifloyd

Thanks for starting the discussion. If we want to do this, now would probably be a good time indeed. I'm not explicitly for or against, but I do want to mention two downsides.

  • It's hard to do it gradual, so it will obfuscate the git history a bit.
  • It might be a hurdle for new contributors and lead to some additional discussion / rework on PR.

The setup can be made simple though, I really like the way it's set up on werkzeug.

@Ruwann
Copy link
Member

Ruwann commented Mar 21, 2022

I think it is indeed a good timing to introduce black, and I believe the downsides are fairly limited:

The werkzeug way does indeed seem very nice and simple - and our contributing docs could use a small upgrade

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants