Update pip pre-release compatibility information#17788
Update pip pre-release compatibility information#17788zanieb merged 5 commits intoastral-sh:mainfrom
Conversation
Co-authored-by: Charlie Marsh <[email protected]>
1a1c3b2 to
b0289ec
Compare
b0289ec to
787dcda
Compare
| 1. If the package is a direct dependency, and its version markers include a pre-release specifier | ||
| (e.g., `flask>=2.0.0rc1`). | ||
| 1. If _all_ published versions of a package are pre-releases. | ||
| 2. If _all_ published versions of a package are pre-releases. |
There was a problem hiding this comment.
This was previously relying on the renderer to change this to the next number
docs/pip/compatibility.md
Outdated
| package. `pip`, meanwhile, respects pre-release identifiers in transitive dependencies, and allows | ||
| pre-releases of transitive dependencies if no stable versions match the dependency requirements. |
There was a problem hiding this comment.
Can we somehow note that this is a recent development? It'll be a while before people are on the new pip version. Maybe something like "In the past, this behavior was unreliable, but as of pip ... the behavior is consistent."
There was a problem hiding this comment.
Couldn't think of a non-clunky way to do this so I just added a note at the end of the paragraph.
docs/pip/compatibility.md
Outdated
| ([#1641](https://github.com/astral-sh/uv/issues/1641#issuecomment-1981402429)). | ||
| package. Meanwhile `pip`, respects pre-release identifiers in transitive dependencies, and allows | ||
| pre-releases of transitive dependencies if no stable versions match the dependency requirements. | ||
| Note: this behavior was made consistent in `pip` 26.0. |
There was a problem hiding this comment.
If you're going to write it in this style, prefixed by "Note: " (which I don't really prefer, but truly don't have strong feelings about at all) then we should use an admonition, e.g.,
!!! note
Prior to pip 26.0, this behavior was not consistent.
There was a problem hiding this comment.
Sure, I don't prefer adding a note, but trying to add it in the sentence came off as clunky.
As of pip 26.0 I believe all outstanding bugs and questions about pre-release behavior in pip are resolved.