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

Coding style standard #5719

Closed
frafra opened this issue Feb 18, 2020 · 0 comments · Fixed by #5720
Closed

Coding style standard #5719

frafra opened this issue Feb 18, 2020 · 0 comments · Fixed by #5720
Assignees
Labels
feature A new feature to be added to the codebase minor A low priority issue which might affect only some users and /or not the main functionality
Milestone

Comments

@frafra
Copy link
Contributor

frafra commented Feb 18, 2020

Is your feature request related to a problem? Please describe.
Coding style standard is inconsistent.

Describe the solution you'd like
black is a great tool to reformat your code. Together with pre-commit can assure that every commit follows the rules. A badly formatted modified file make impossible to commit, because the file gets changed/reformatted during the commit phase. Adding the file again will make commit work again.

This mechanism works only if pre-commit is installed on the client (those are client-side hooks).

Describe alternatives you've considered
flake8 is just a checker and we could spare dev time by just use a code formatter.
isort is also nice, but it is for imports only and it would be more a nice additional hook than a replacement for black.

Additional context
I am not proposing to reformat everything at once: that would break git history. Giving a nice tool to help developers respecting code style rules for new commit could improve things over time.

This change would preferably require to update the documentation too.

@frafra frafra self-assigned this Feb 18, 2020
@frafra frafra added feature A new feature to be added to the codebase minor A low priority issue which might affect only some users and /or not the main functionality labels Feb 18, 2020
@frafra frafra added this to the 3.0 milestone Feb 18, 2020
@frafra frafra linked a pull request Feb 18, 2020 that will close this issue
11 tasks
frafra added a commit that referenced this issue Feb 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature A new feature to be added to the codebase minor A low priority issue which might affect only some users and /or not the main functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant