Skip to content

Add #[doc(fake_variadic)] to some places where it's missing#20847

Merged
alice-i-cecile merged 1 commit intobevyengine:mainfrom
chescock:missing-fake_variadic
Sep 3, 2025
Merged

Add #[doc(fake_variadic)] to some places where it's missing#20847
alice-i-cecile merged 1 commit intobevyengine:mainfrom
chescock:missing-fake_variadic

Conversation

@chescock
Copy link
Copy Markdown
Contributor

@chescock chescock commented Sep 3, 2025

Objective

See #14697. We use #[doc(fake_variadic)] for most of our trait impls for tuples, but it's missing for a few, mostly traits that were added after #14703:

  • BundleEffect
  • NoBundleEffect
  • ReadOnlyQueryData
  • ReleaseStateQueryData
  • SpawnableList
  • SpecializerKey

Solution

Pass #[doc(fake_variadic)] through all_tuples! for those trait impls.

Testing

Ran RUSTFLAGS='--cfg docsrs_dep' RUSTDOCFLAGS='--cfg=docsrs' cargo +nightly doc

image image image

@chescock chescock added C-Docs An addition or correction to our documentation A-Rendering Drawing game state to the screen A-ECS Entities, components, systems, and events D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Sep 3, 2025
@alice-i-cecile alice-i-cecile added the X-Uncontroversial This work is generally agreed upon label Sep 3, 2025
@alice-i-cecile alice-i-cecile requested a review from cart September 3, 2025 21:36
@james7132 james7132 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 Sep 3, 2025
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Sep 3, 2025
Merged via the queue into bevyengine:main with commit 611bf0c Sep 3, 2025
47 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-ECS Entities, components, systems, and events A-Rendering Drawing game state to the screen 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 X-Uncontroversial This work is generally agreed upon

Projects

No open projects
Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants