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

Fix typo in NamedTypePathDef #9102

Merged
merged 1 commit into from Jul 10, 2023

Conversation

Cptn-Sherman
Copy link
Contributor

@Cptn-Sherman Cptn-Sherman commented Jul 10, 2023

Objective

Fixes #9091

Solution

Rename instances of Primtive to Primitive

Migration Guide

  • Renamed NamedTypePathDef::Primtive to NamedTypePathDef::Primitive

Before:

let type_path = NamedTypePathDef::Primtive(ident);

After:

let type_path = NamedTypePathDef::Primitive(ident);

@github-actions
Copy link
Contributor

Welcome, new contributor!

Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨

@Selene-Amanita Selene-Amanita added C-Usability A simple quality-of-life change that makes Bevy easier to use A-Reflection Runtime information about types C-Breaking-Change A breaking change to Bevy's public API that needs to be noted in a migration guide labels Jul 10, 2023
@github-actions
Copy link
Contributor

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.

@Selene-Amanita Selene-Amanita added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jul 10, 2023
@james7132 james7132 added this pull request to the merge queue Jul 10, 2023
Merged via the queue into bevyengine:main with commit aa03130 Jul 10, 2023
25 checks passed
@Selene-Amanita
Copy link
Member

Selene-Amanita commented Jul 10, 2023

@Cptn-Sherman Despite this being merged, can you still provide a Migration Guide by editing your first message? Even though this is trivial, it is a breaking change and will need to appear in the migration guide of 0.11->0.12 which will be pulled automatically from this PR.

@Cptn-Sherman
Copy link
Contributor Author

@Cptn-Sherman Despite this being merged, can you still provide a Migration Guide by editing your first message? Even though this is trivial, it is a breaking change and will need to appear in the migration guide of 0.11->0.12 which will be pulled automatically from this PR.

I have updated my original message. Please let me know if this guide is insufficient, I did not see any documentation in the contributing guide on adding a migration guide.

@Selene-Amanita
Copy link
Member

Selene-Amanita commented Jul 10, 2023

I have updated my original message. Please let me know if this guide is insufficient, I did not see any documentation in the contributing guide on adding a migration guide.

Thank you! It's in the placeholder when you create the PR I think. But it should be added to the contributing guide yeah :(

Maybe add a sentence before "Renamed NamedTypePathDef::Primtive to NamedTypePathDef::Primitive"?

Edit: here: #9104

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Reflection Runtime information about types C-Breaking-Change A breaking change to Bevy's public API that needs to be noted in a migration guide C-Usability A simple quality-of-life change that makes Bevy easier to use 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
Development

Successfully merging this pull request may close these issues.

Typo in bevy_reflect_derive
3 participants