Skip to content

Use en-us locale for typos#16037

Merged
alice-i-cecile merged 2 commits intobevyengine:mainfrom
rparrett:en-us-locale
Oct 20, 2024
Merged

Use en-us locale for typos#16037
alice-i-cecile merged 2 commits intobevyengine:mainfrom
rparrett:en-us-locale

Conversation

@rparrett
Copy link
Copy Markdown
Contributor

@rparrett rparrett commented Oct 20, 2024 •
edited
Loading

Objective

Bevy seems to want to standardize on "American English" spellings. Not sure if this is laid out anywhere in writing, but see also #15947.

While perusing the docs for typos, I noticed that it has a locale config option and tried it out.

Solution

Switch to en-us locale in the typos config and run typos -w

Migration Guide

The following methods or fields have been renamed from *dependants* to *dependents*.

  • ProcessorAssetInfo::dependants
  • ProcessorAssetInfos::add_dependant
  • ProcessorAssetInfos::non_existent_dependants
  • AssetInfo::dependants_waiting_on_load
  • AssetInfo::dependants_waiting_on_recursive_dep_load
  • AssetInfos::loader_dependants
  • AssetInfos::remove_dependants_and_labels

@alice-i-cecile alice-i-cecile added A-Build-System Related to build systems or continuous integration A-Cross-Cutting Impacts the entire engine D-Straightforward Simple bug fixes and API improvements, docs, test and examples labels Oct 20, 2024
@alice-i-cecile
Copy link
Copy Markdown
Member

alice-i-cecile commented Oct 20, 2024

We do want to standardize on it. It should be in the contributing guide but isn't. Let me make an issue...

@alice-i-cecile alice-i-cecile mentioned this pull request Oct 20, 2024
Open
@rparrett rparrett added the M-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide label Oct 20, 2024
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 20, 2024

It looks like your PR is a breaking change, but you didn't provide a migration guide.

Could you add some context on what users should update when this change get released in a new version of Bevy?
It will be used to help writing the migration guide for the version. Putting it after a ## Migration Guide will help it get automatically picked up by our tooling.

@alice-i-cecile alice-i-cecile added the S-Needs-Review Needs reviewer attention (from anyone!) to move forward label Oct 20, 2024
@IceSentry IceSentry added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Oct 20, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Oct 20, 2024
Merged via the queue into bevyengine:main with commit 30d8451 Oct 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

@mockersf mockersf mockersf approved these changes

+1 more reviewer

@IceSentry IceSentry IceSentry approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

A-Build-System Related to build systems or continuous integration A-Cross-Cutting Impacts the entire engine D-Straightforward Simple bug fixes and API improvements, docs, test and examples M-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@rparrett @alice-i-cecile @IceSentry @mockersf