search

john-hen / Flake8-pyproject

Flake8 plug-in loading the configuration from pyproject.toml
https://pypi.org/project/Flake8-pyproject
MIT License
218 stars 10 forks source link

Use less hostile phrasing in documentation #24

Closed benblank closed 10 months ago

benblank commented 10 months ago

Flake8-pyproject provides a very simple solution to what is clearly a common irritation and I'm certainly glad it exists. However, I find myself hesitant to use it in published projects because I'm uncomfortable implicitly "endorsing" the phrasing used in the project's description of itself.

It's pretty clear those paragraphs were born from the same frustration that the entire project was, but I think they come off as pretty hostile towards our fellow developers. I'd be a lot more comfortable with a less inflammatory tone, and I suspect that's even more true for developers working in business environments (which tend to be even more cautious with appearances and communication).

This PR changes only the introductory paragraphs near the top of ReadMe.md and PyPI.md. I've tried to shift the tone towards a more "stating the facts" voice without altering too much what is being said.

The diffs are below, of course, but for clarity, here are the new paragraphs I'm proposing:

Flake8 cannot currently be configured via pyproject.toml, the file which has been proposed by PEP-518 for tool configuration and which has been adopted by many other Python code quality tools. Though the project has tentative plans to support pyproject.toml, it has been considered blocked on other tools' behavior for years.

This means that developers wishing to consolidate their configuration files are still unable to fully do so. Enter Flake8-pyproject, which registers itself as a Flake8 plug-in and allows seamlessly loading the tool's configuration from pyproject.toml when you run the flake8 command.

john-hen commented 10 months ago

The phrasing in the project description is already factual, complete with references. Your disparaging it as "hostile" and "inflammatory" is, quite frankly, just that.

If the PyCQA chooses to ignore its own Code of Conduct, that's deplorable, but also in the volunteer nature of things. It does not, however, mean that we all have to close our eyes and pretend it never happened. Least of all, in order to cater to the vaguely defined needs of business environments, where such unprofessional behavior would not be tolerated.

Please use an alternative to either this project or pyproject.toml. There are plenty.