Skip to content

Update trait tags for resources-as-components#24222

Merged
alice-i-cecile merged 1 commit into
bevyengine:mainfrom
SpecificProtagonist:push-qqpkuvutnuwm
May 13, 2026
Merged

Update trait tags for resources-as-components#24222
alice-i-cecile merged 1 commit into
bevyengine:mainfrom
SpecificProtagonist:push-qqpkuvutnuwm

Conversation

@SpecificProtagonist
Copy link
Copy Markdown
Contributor

@SpecificProtagonist SpecificProtagonist commented May 9, 2026

Objective

Follow up on resources-as-components.
Update trait tags in rustdoc-generated documentation:

  • do not add component tag on resources, as that's offers no new information
  • mark immutable resources as immutable, like with component trait

Testing

RUSTDOCFLAGS="--html-after-content docs-rs/trait-tags.html --cfg docsrs_dep" RUSTFLAGS="--cfg docsrs_dep" cargo doc --no-deps --package bevy_ecs

Showcase

Before:
Screenshot_20260509_233133
After:
Screenshot_20260509_233051

@SpecificProtagonist SpecificProtagonist added C-Docs An addition or correction to our documentation S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels May 9, 2026
@alice-i-cecile alice-i-cecile added this to the 0.19 milestone May 10, 2026
kfc35
kfc35 approved these changes May 10, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@kfc35 kfc35 left a comment

Choose a reason for hiding this comment

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

lgtm

@kfc35 kfc35 added the D-Straightforward Simple bug fixes and API improvements, docs, test and examples label May 10, 2026
@Zeophlite Zeophlite 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 May 10, 2026
@alice-i-cecile alice-i-cecile added this pull request to the merge queue May 13, 2026
Merged via the queue into bevyengine:main with commit e3b63dc May 13, 2026
47 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@Zeophlite Zeophlite Zeophlite approved these changes

@kfc35 kfc35 kfc35 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

C-Docs An addition or correction to our documentation D-Straightforward Simple bug fixes and API improvements, docs, test and examples 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

0.19

Development

Successfully merging this pull request may close these issues.

4 participants

@SpecificProtagonist @Zeophlite @kfc35 @alice-i-cecile