Skip to content

Conversation

@alice-i-cecile
Copy link
Member

@alice-i-cecile alice-i-cecile commented Sep 22, 2025

Objective

Solution

  • better contextualize the changes
  • quote the exact migration guide
  • quote the error message for grepping
  • mention that bevy_cli has an easy fix for this and tell people to upgrade

@alice-i-cecile
Copy link
Member Author

@Bluefinger can I get your review here?

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation O-Web Specific to web (WASM) builds A-Math Fundamental domain-agnostic mathematical operations S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Sep 22, 2025
@james7132 james7132 added this to the 0.17 milestone Sep 22, 2025

You may encounter an error like:

```toml
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```toml
```sh

(Nit) I think setting the syntax highlighting to TOML is misleading, as this is a message you would see in the shell and not in a TOML file.

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree that it's misleading, but sh makes the formatting worse, because it's formatted as "shell input". The TOML formatting at least gets the quote right, and I can't leave it untagged or the linter complains.

Copy link
Member

Choose a reason for hiding this comment

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

Gotcha, makes sense!

Co-authored-by: Gonçalo Rica Pais da Silva <[email protected]>
Co-authored-by: BD103 <[email protected]>
@alice-i-cecile alice-i-cecile changed the base branch from main to release-0.17.0 September 22, 2025 17:43
@alice-i-cecile
Copy link
Member Author

Ugh, changing branch has done very bad things to the diff here. I'm going to have to remake this.

@alice-i-cecile alice-i-cecile changed the base branch from release-0.17.0 to main September 22, 2025 23:40
@alice-i-cecile
Copy link
Member Author

Remade the PR targeting the 0.17 branch.

alice-i-cecile added a commit that referenced this pull request Sep 22, 2025
# Objective

We still need to improve these migration guides, but we cut them from
`main`.

Fixes #21039.

## Solution

Adopt #21162 targeting the 0.17 release branch.
Cherrypick the same commits to a new branch targeting the new branch
rather than main.

---------

Co-authored-by: Gonçalo Rica Pais da Silva <[email protected]>
Co-authored-by: BD103 <[email protected]>
Co-authored-by: DAA <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Math Fundamental domain-agnostic mathematical operations C-Docs An addition or correction to our documentation O-Web Specific to web (WASM) builds S-Needs-Review Needs reviewer attention (from anyone!) to move forward

Projects

None yet

Development

Successfully merging this pull request may close these issues.

rand / getrandom migration guide is slightly misleading

5 participants