Skip to content

Conversation

WaterWhisperer
Copy link
Contributor

Objective

Fixes #14309

Solution

Renamed the bevy_reflect feature from documentation to reflect_documentation to follow the naming convention where features are prefixed with their module name.

Changes

  • Renamed feature documentation to reflect_documentation in:
    • bevy_reflect/Cargo.toml
    • bevy_reflect/derive/Cargo.toml
    • bevy_internal/Cargo.toml
  • Updated all conditional compilation attributes from #[cfg(feature = "documentation")] to #[cfg(feature = "reflect_documentation")]
  • Updated example documentation in reflect_docs.rs

Testing

截图 2025-10-17 18-52-14

@WaterWhisperer
Copy link
Contributor Author

This PR renames a Cargo feature. Should this have a migration guide?

Users who explicitly enabled bevy_reflect/documentation in their Cargo.toml would need to change it to bevy_reflect/reflect_documentation. However, I'm not sure how common this use case is.

If needed, I‘ll add a migration guide.

@alice-i-cecile alice-i-cecile added C-Usability A targeted quality-of-life change that makes Bevy easier to use A-Reflection Runtime information about types M-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide labels Oct 17, 2025
@alice-i-cecile alice-i-cecile requested a review from atlv24 October 17, 2025 16:37
@alice-i-cecile alice-i-cecile added the S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged label Oct 17, 2025
Copy link
Contributor

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

Please review the instructions for writing migration guides, then expand or revise the content in the migration guides directory to reflect your changes.

Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

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

I quite like this change but it needs a migration guide entry :)

@alice-i-cecile alice-i-cecile 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-Waiting-on-Author The author needs to make changes or address concerns before this can be merged labels Oct 19, 2025
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Oct 19, 2025
Merged via the queue into bevyengine:main with commit a48d6cd Oct 19, 2025
42 checks passed
@WaterWhisperer WaterWhisperer deleted the rename branch October 20, 2025 04:13
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-Usability A targeted quality-of-life change that makes Bevy easier to use 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

Development

Successfully merging this pull request may close these issues.

Rename bevy_reflect's documentation feature to `reflect_documentation

3 participants