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

Retain end-of-line comment position when adding dependency #12360

Merged

Conversation

christeefy
Copy link
Contributor

@christeefy christeefy commented Mar 21, 2025

Summary

This fixes a case described in #12333, where trailing comments in dependencies can be unexpectedly shifted when a new dependency is added.

Fixes #12333.

Test Plan

cargo test (Added a snapshot test)

@christeefy christeefy changed the title 🐛 Bug/retain trailing comment position 🐛 Retain trailing comment position when adding dependency Mar 21, 2025
@christeefy christeefy marked this pull request as draft March 21, 2025 09:57
@christeefy
Copy link
Contributor Author

christeefy commented Mar 21, 2025

I'm realizing that testing is done using insta. I can move my test logic to the other module, and refactor the documentation, before marking this as ready.

@christeefy christeefy marked this pull request as ready for review March 21, 2025 11:48
@christeefy christeefy changed the title 🐛 Retain trailing comment position when adding dependency 🐛 Retain end-of-line comment position when adding dependency Mar 21, 2025
@zanieb zanieb requested a review from Gankra March 21, 2025 13:41
Copy link
Contributor

@Gankra Gankra left a comment

Choose a reason for hiding this comment

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

Wow this function does some real heroics for formatting, thanks for the fix!

@Gankra Gankra added the bug Something isn't working label Mar 21, 2025
@Gankra Gankra changed the title 🐛 Retain end-of-line comment position when adding dependency Retain end-of-line comment position when adding dependency Mar 21, 2025
@Gankra Gankra merged commit bdef77c into astral-sh:main Mar 21, 2025
76 checks passed
@christeefy christeefy deleted the bug/retain-trailing-comment-position branch March 22, 2025 00:30
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request Mar 26, 2025
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.6.9` -> `0.6.10` |

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.6.10`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0610)

[Compare Source](astral-sh/uv@0.6.9...0.6.10)

##### Enhancements

-   Add `uv sync --check` flag ([#&#8203;12342](astral-sh/uv#12342))
-   Add support for Python version requests in `uv python list` ([#&#8203;12375](astral-sh/uv#12375))
-   Support `.env` files in `uv tool run` ([#&#8203;12386](astral-sh/uv#12386))
-   Support `python find --script` ([#&#8203;11891](astral-sh/uv#11891))

##### Preview features

-   Check all compatible torch indexes when `--torch-backend` is enabled ([#&#8203;12385](astral-sh/uv#12385))

##### Performance

-   Use a boxed slice for extras and groups ([#&#8203;12391](astral-sh/uv#12391))
-   Use small string for index name type ([#&#8203;12355](astral-sh/uv#12355))

##### Bug fixes

-   Allow virtual packages with `--no-build` ([#&#8203;12314](astral-sh/uv#12314))
-   Ignore `--find-links` entries for pinned indexes ([#&#8203;12396](astral-sh/uv#12396))
-   Omit wheels from lockfile based on `--exclude-newer` ([#&#8203;12299](astral-sh/uv#12299))
-   Retain end-of-line comment position when adding dependency ([#&#8203;12360](astral-sh/uv#12360))
-   Omit fragment when querying for wheels in Simple HTML API ([#&#8203;12384](astral-sh/uv#12384))
-   Error on missing argument in `requirements.txt` ([#&#8203;12354](astral-sh/uv#12354))
-   Support modules with different casing in build backend ([#&#8203;12240](astral-sh/uv#12240))
-   Add authentication policy support for `pip` commands ([#&#8203;12470](astral-sh/uv#12470))

</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:eyJjcmVhdGVkSW5WZXIiOiIzOS4yMTMuNSIsInVwZGF0ZWRJblZlciI6IjM5LjIxMy41IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiXX0=-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Comments for pyproject.toml dependencies get shifted unexpectedly
2 participants