Clarify requirements file format in docs #17284
Conversation
woodruffw
left a comment
There was a problem hiding this comment.
I think this is actually intentional -- requirements.txt refers to both the conventional filename and the name of the format itself, so what the docs are saying is that there's a file named requirements.in that's in requirements.txt format.
I can see how it could be intended to read like that, but when I read this paragraph the first time that's definitely not how it parsed for me. In this part of the docs, there has also been no prior explanation about the "requirements.txt format". Maybe the text could still be updated somehow to avoid confusion. Maybe something like
Anyway, feel free to close if you want to keep as-is, ofc! |
|
Yeah, I completely agree it's confusing 😅 -- maybe we could link to pip's documentation for this, since I think that's the canonical source for the format: https://pip.pypa.io/en/stable/reference/requirements-file-format/ Also, I apologize -- I thought the actual name of the format was I'll make a suggestion on top of your PR for that. |
Co-authored-by: William Woodruff <william@yossarian.net>
|
Yep, makes sense, definitely less confusing and more informative with the link. Thanks! |
This MR contains the following updates: | Package | Update | Change | |---|---|---| | [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.9.21` → `0.9.22` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>astral-sh/uv (astral-sh/uv)</summary> ### [`v0.9.22`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0922) [Compare Source](astral-sh/uv@0.9.21...0.9.22) Released on 2026-01-06. ##### Enhancements - Use a dedicated error message when lockfile can't be found ([#​17318](astral-sh/uv#17318)) ##### Bug fixes - Filter unusable wheels from the lockfile for more architectures ([#​17317](astral-sh/uv#17317)) - Correctly count retries originating from early middleware errors ([#​17274](astral-sh/uv#17274)) ##### Documentation - Clarify requirements file format in docs ([#​17284](astral-sh/uv#17284)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0Mi43NS4xIiwidXBkYXRlZEluVmVyIjoiNDIuNzUuMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90IiwiYXV0b21hdGlvbjpib3QtYXV0aG9yZWQiLCJkZXBlbmRlbmN5LXR5cGU6OnBhdGNoIl19-->
Summary
The docs for
requirements.incurrently wrongly refer torequirements.txtin the first sentence:The occurrence in bold should be requirements.in instead.