Skip to content

Move bsn! macro docs back into macro crate, avoiding re-re-export issues#24828

Open
laundmo wants to merge 2 commits into
bevyengine:mainfrom
laundmo:bsn-macro-docs-move-back
Open

Move bsn! macro docs back into macro crate, avoiding re-re-export issues#24828
laundmo wants to merge 2 commits into
bevyengine:mainfrom
laundmo:bsn-macro-docs-move-back

Conversation

@laundmo

@laundmo laundmo commented Jul 1, 2026

Copy link
Copy Markdown
Member

Objective

Solution

Testing

  • Compiled docs with
    cargo doc --lib --config 'build.rustflags=["--cfg", "docsrs_dep"]' -Zhost-config -Ztarget-applies-to-host --config 'host.rustflags=["--cfg", "docsrs_dep"]' --config 'build.rustdocflags=["-Zunstable-options", "--generate-link-to-definition", "--generate-macro-expansion", "--html-after-content", "./docs-rs/trait-tags.html"]' --no-deps -p bevy --all-features
    which approximately matches what docs.rs would run. Did this once with -p bevy and once with -p bevy_scene, both show the macro docs.

Fixes #24703
Closes #24750
Closes #24820

…ix rust-analyzer preferring module of same name
@laundmo laundmo added C-Docs An addition or correction to our documentation D-Straightforward Simple bug fixes and API improvements, docs, test and examples A-Scenes Composing and serializing ECS objects S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jul 1, 2026
@laundmo laundmo added this to the 0.19.1 milestone Jul 1, 2026

@ItsDoot ItsDoot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@ItsDoot ItsDoot 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 Jul 3, 2026
@ItsDoot

ItsDoot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Will need to fix some broken doc links as mentioned by CI

@alice-i-cecile alice-i-cecile added S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged and removed S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Jul 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Scenes Composing and serializing ECS objects C-Docs An addition or correction to our documentation D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

published (docs.rs) bsn! and bsn_list! docs are broken Links to bsn! is broken in scene module

4 participants