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

tech: Apply Black to the entire codebase. #1814

Conversation

lauryndbrown
Copy link
Contributor

Updates the README and runs Black on everything with the commit skipped by the git blame. As of the creation of this PR. This is not true for the GitHub blame UI:

The one caveat is that GitHub and GitLab do not yet support ignoring revisions using their native UI of blame. So blame information will be cluttered with a reformatting commit on those platforms. (If you'd like this feature, there's an open issue for GitLab and please let GitHub know!)

See for more info on the process: https://github.com/psf/black/#migrating-your-code-style-without-ruining-git-blame

Fixes #1812.

@lauryndbrown lauryndbrown marked this pull request as draft February 25, 2021 16:40
@lauryndbrown lauryndbrown self-assigned this Feb 26, 2021
@lauryndbrown lauryndbrown added component: documentation python Pull requests that update Python code labels Feb 26, 2021
@lauryndbrown lauryndbrown marked this pull request as ready for review February 26, 2021 23:00
Copy link
Contributor

@pbanaszkiewicz pbanaszkiewicz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@pbanaszkiewicz pbanaszkiewicz added this to the v2.17 milestone Feb 27, 2021
@lauryndbrown lauryndbrown merged commit 76c89bc into carpentries:develop Feb 27, 2021
@lauryndbrown lauryndbrown deleted the 1812/run-black-on-entire-codebase branch February 27, 2021 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Tech] Run black on whole codebase, and provide blame commit rev
2 participants