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

Reformat using black #73

Closed
wants to merge 1 commit into from
Closed

Conversation

matt-kempster
Copy link

The black autoformatter (https://github.com/psf/blackhttps://github.com/psf/black) is a common way to unify the style of a project.

The things that are substantially different:

  • Spaces instead of tabs
  • Double-quotes instead of single-quotes
  • Lines limited to 88 characters
  • Newlines used only when needed

There are a few things we can manually improve via "magic commas" (psf/black#1288) like matrices, but I think this is a good start.

Feel free to reject this PR :) I just figured I'd introduce it to make it a bit easier for people to contribute to a consistent style.

@Dragorn421
Copy link
Contributor

Thanks for the PR! Yes we do want to format the repo. I'm personally a black fan and I got @thecozies somewhat convinced 😄

However we think doing it bits at a time, because it's too much to review as a single thing, and we'd like to tweak some files as they get formatted (moving stuff around, adding commas), maybe ignore some files (e.g. f3d_constants.py).

So again we'd rather do it in chunks instead of all at once.

If you had something specific in mind to contribute on, but were astonished at how poorly formatted the code is, and want to have specific files formatted before working on them, feel free to submit a PR with partial formatting (only the files or bits that you intend to edit)

I'll open an issue related to the formatting to keep track of things

@Dragorn421 Dragorn421 mentioned this pull request Feb 15, 2022
@Dragorn421 Dragorn421 closed this Mar 12, 2022
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 this pull request may close these issues.

2 participants