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

Use Black code style? #609

Closed
osma opened this issue Aug 16, 2022 · 0 comments · Fixed by #640
Closed

Use Black code style? #609

osma opened this issue Aug 16, 2022 · 0 comments · Fixed by #640
Assignees
Milestone

Comments

@osma
Copy link
Member

osma commented Aug 16, 2022

Black seems to be in fashion. Adopting it would rid us of code style related worries.

If we decide to use it, we should consider using the following integrations:

  • integrate Black with IDEs used by developers, when possible
  • have a simple command to reformat all files with Black (or just check conformity)
  • have a git pre-commit hook that performs Black reformatting (e.g. this tutorial which shows how to do it without using pre-commit.com, which would be an option too)
  • have Black check the code under GitHub Actions CI

Black would replace autopep8 that we're currently using. There's still a need for flake8 checks, because flake8 checks other things than just pep8 code style.

@osma osma added this to the Long term milestone Aug 16, 2022
@juhoinkinen juhoinkinen self-assigned this Sep 5, 2022
@osma osma modified the milestones: Long term, 0.60 Nov 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants