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 outdated compatibility matrix from README #1950

Merged
merged 1 commit into from
Aug 4, 2023
Merged

Remove outdated compatibility matrix from README #1950

merged 1 commit into from
Aug 4, 2023

Conversation

jeffwidman
Copy link
Contributor

@jeffwidman jeffwidman commented Aug 4, 2023

As noted in #1937, this matrix is out of date now that https://github.com/jazzband/pip-tools/releases/tag/7.0.0 has shipped.

Technically it could be kept around and add some more rows, but I don't think it's worth the effort... it will always be going out of date. Instead, let the internal dep constraints and classifiers within setup.py/pyproject.toml constrain what versions of python / pip are compatible with that version of pip-tools. Most users won't care, but those who will can access that data manually. And otherwise it'll all be smoothly resolved by package managers.

So let's just remove it altogether.

Fix: #1937

Contributor checklist
  • Included tests for the changes.
  • PR title is short, clear, and ready to be included in the user-facing changelog.
Maintainer checklist
  • Verified one of these labels is present: backwards incompatible, feature, enhancement, deprecation, bug, dependency, docs or skip-changelog as they determine changelog listing.
  • Assign the PR to an existing or new milestone for the target version (following Semantic Versioning).

As noted in #1937, this matrix is out of date now that https://github.com/jazzband/pip-tools/releases/tag/7.0.0 has shipped.

Technically it could be kept around and add some more rows, but I don't think it's worth the effort... it will always be going out of date. Instead, let the internal dep constraints within `setup.py`/`pyproject.toml` constrain what versions of `python` / `pip` are compatible with that version of `pip-tools`. Most users won't care, but those who will can access that data manually. And otherwise it'll all be smoothly resolved by package managers.

So let's just remove it altogether.
@chrysle
Copy link
Contributor

chrysle commented Aug 4, 2023

Instead, let the internal dep constraints within setup.py/pyproject.toml constrain what versions of python / pip are compatible with that version of pip-tools. Most users won't care, but those who will can access that data manually.

Though this only provides constraints for the current version, throwing away the carefully curated information about historical versions.

At least there should be a general note about compatibility.

@chrysle chrysle added docs Documentation related skip-changelog Avoid listing in changelog labels Aug 4, 2023
@jeffwidman
Copy link
Contributor Author

I don't follow... Were these dep / classifier versions not pinned in previous releases? It's not hard to look at the contents of a file for a particular release tag...

My point was that very few users care about this information and for those who do it's not hard to retrieve that data.

If they weren't pinned in the past, well, then yeah might be tough to find without trial and error.

Regardless, now that 3.6 (and now even 3.7) is eol'd and I see more and more packages dropping support for them, won't be too long until there won't be much demand for a package manager that supports older python versions simply because there aren't package updates available.

@chrysle
Copy link
Contributor

chrysle commented Aug 4, 2023

I don't follow... Were these dep / classifier versions not pinned in previous releases? It's not hard to look at the contents of a file for a particular release tag...

Well yes, that's true. Hadn't thought of the possibility of digging through the tags.

Then maybe could you keep the introduction of that section, but remove the table and say that required pip versions can be determined via pyproject.toml?

@jeffwidman
Copy link
Contributor Author

jeffwidman commented Aug 4, 2023

Cool, yeah, some days it feels like I spend hours doing git bisect + git blame followed by 5 mins to make a 1 line change. 😁

Then maybe could you keep the introduction of that section, but remove the table and say that required pip versions can be determined via pyproject.toml?

I personally don't think that section has enough value to merit being on the README...

Users won't care until they run into a problem, in which case they'll google / stackoverflow / start looking at setup.py / pyproject.toml etc. And then they'll probably be told they need to bump to a newer version of python or pip, which IMO in most situations is the better solution.

And when it's not, generally they (or whoever is answering their question on StackOverflow) will tell them to look at pyproject.toml.

But I just don't see them at any point in this process going to the readme to say "How do I find the supported versions?"

Just my $0.02, no problem if you disagree and prefer to solve differently, I'm a drive-by contributor, not a maintainer here.

Copy link
Contributor

@chrysle chrysle left a comment

Choose a reason for hiding this comment

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

Let's do it then! Always happy to find an agreement.

Copy link
Member

@atugushev atugushev left a comment

Choose a reason for hiding this comment

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

For the last 3 years I've never seen someone use this table.

@atugushev atugushev merged commit 2cdd69d into jazzband:main Aug 4, 2023
34 checks passed
@atugushev
Copy link
Member

Thanks @jeffwidman and @chrysle!

@chrysle
Copy link
Contributor

chrysle commented Aug 4, 2023

For the last 3 years I've never seen someone use this table.

How can you possibly see that? ;-)

@atugushev
Copy link
Member

How can you possibly see that? ;-)

Assumption is based on the number of times I've referred users to this section.

@jeffwidman
Copy link
Contributor Author

jeffwidman commented Aug 4, 2023

For the last 3 years I've never seen someone use this table.

How can you possibly see that? ;-)

It's @atugushev. He sees things that are impossible for normal people to see 😁 :

image

@jeffwidman jeffwidman deleted the jeffwidman-patch-1 branch August 4, 2023 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related skip-changelog Avoid listing in changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update compatibility matrix
3 participants