Skip to content

Make safety comments on unsafe traits internal comments #22653

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.

Sign up for GitHub

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

Jump to bottom
Open
hymm wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Make safety comments on unsafe traits internal comments #22653

hymm wants to merge 1 commit into from
+153 −153

Conversation

@hymm
Copy link
Contributor

@hymm hymm commented Jan 22, 2026

Objective

  • Safety comments on implementations of unsafe traits should not be part of the public docs as these are meant to bevy devs explain why implementing the trait is safe.

Solution

  • Make them regular doc comments

@hymm hymm changed the title convert doc comments to internal comments Make safety comment on unsafe traits internal comments Jan 22, 2026
@hymm hymm changed the title Make safety comment on unsafe traits internal comments Make safety comments on unsafe traits internal comments Jan 22, 2026
@alice-i-cecile alice-i-cecile added A-ECS Entities, components, systems, and events C-Code-Quality A section of code that is hard to understand or change X-Contentious There are nontrivial implications that should be thought through S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jan 22, 2026
@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-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jan 26, 2026
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

+1 more reviewer

@chescock chescock chescock approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

A-ECS Entities, components, systems, and events C-Code-Quality A section of code that is hard to understand or change S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it X-Contentious There are nontrivial implications that should be thought through

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@hymm @alice-i-cecile @chescock