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 a third motivating example and pre-commit example #2

Merged
merged 3 commits into from
Jun 26, 2020

Conversation

bluemellophone
Copy link
Contributor

@bluemellophone bluemellophone commented Jun 26, 2020

The maintainers of pip have been working behind the scenes (pypa/pip#8437 (comment)) to add build isolation configurations to newer versions. This uses a project.toml file to ensure configuration information is provided in a scripted way, but was co-opted by the developers of Flake8 and Black before it could realistically be used for pip-only applications. As a result, if a project.toml file exists in a repository for the purposes of configuring Black it will force pip to use the more locked down build process and will cause various issues like import failures in setup.py. The natural solution is to move to the most standardized setup.cfg file for Black, but the maintainers refused to allow this option. Luckily, your project allows exactly this feature. I've added a third motivating example to your list to highlight this issue and provide a more direct link for people who are looking to jump ship from Black's stubbornness.

I've also added a description on how to do a drop-in-replacement from Black to Brunette as used by pre-commit.

Finally, I had a developer friend comment on the somewhat sensitive/risky naming convention by using the term brunette. I'm sure that this was an innocent play on words, but explaining that explicitly in the READMe with an added anti-gender-discrimination discussion may help to reassure collaborators. (Removed per request of maintainer)

…added configuration for pre-commit, and added anti-gender-discrimination discussion
@richardARPANET
Copy link
Contributor

Hey @bluemellophone. Thanks for the changes 👍 . All looks great except I don't like the gender blurb.

There's nothing wrong with the hypothetical that it could be named after a hair colour, just like there's nothing wrong with most ships having a female name :)

If anyone is triggered by the name then I don't want to live on this planet anymore.

@bluemellophone
Copy link
Contributor Author

I largely agree, the decision is rightly up to you as one of the maintainers to remove it. I thought it a bit much, but was responding to feedback from another developer.

Should I amend the PR?

@richardARPANET
Copy link
Contributor

Yes please, then I can do another release so the docs update on the PyPI website.

@richardARPANET richardARPANET self-requested a review June 26, 2020 07:20
@richardARPANET richardARPANET merged commit 9f1c4cf into odwyersoftware:master Jun 26, 2020
@bluemellophone bluemellophone changed the title Add a third motivating example and anti-gender discrimination discussion Add a third motivating example and pre-commit example Jun 26, 2020
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