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

remove python-2-compatible rewriting mode #718

Merged
merged 1 commit into from
Oct 4, 2022
Merged

remove python-2-compatible rewriting mode #718

merged 1 commit into from
Oct 4, 2022

Conversation

asottile
Copy link
Owner

@asottile asottile commented Oct 4, 2022

No description provided.

@asottile asottile merged commit 091f30c into main Oct 4, 2022
@asottile asottile deleted the py3-plus branch October 4, 2022 00:40
@EwoutH
Copy link

EwoutH commented Oct 5, 2022

You just closed #722, the reason I opened that is that a major release was tagged without any indication what's new in it by itself. All the information given in the git log and this PR is remove python-2-compatible rewriting mode. I suspect that means that Python files can now only be formatted in Python 3 format. But does it still allow Python 2 files to be formatted? Is suspect yes, but can't know for sure.

A changelog is a means of communication, as are commit messages and PR descriptions. Of course everyone could dive into the code changes and what changed. But they can't see why it changed. Or what the considerations were. Or what unexpected limitations or behaviour could occur. Or why it changed now.

For example, a lot of pre-commit CI configs will be updated to 3.0.0. Maintainers want to quickly see what's new in this major version, and what the caveats are. Some CI builds will break, and then they will want to see what mitigations are possible. For example, what happens if you input the --py3-plus parameter? Will v3.0.0 crash? And if so, probably removing --py3-plus helps. But does v3.0.0 provide the same functionality as --py3-plus did in v2.0? Those are legit questions many maintainers will ask and now need to individually investigate.

This is an amazing piece of tooling and a fantastic quality of life enhancer for the Python ecosystem. But good documentation is key for keeping it accessible and understandable. So please invest in that.

@asottile
Copy link
Owner Author

asottile commented Oct 5, 2022

please don't tell me how to run my projects thanks -- if you want to demand more of my free time then support the "amazing piece of tooling" and sponsor.

Repository owner locked as resolved and limited conversation to collaborators Oct 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants