Skip to content

Minor documentation fixes#24249

Merged
alice-i-cecile merged 3 commits into
bevyengine:mainfrom
eswartz:minor-doc-fixes
May 13, 2026
Merged

Minor documentation fixes#24249
alice-i-cecile merged 3 commits into
bevyengine:mainfrom
eswartz:minor-doc-fixes

Conversation

@eswartz
Copy link
Copy Markdown
Contributor

@eswartz eswartz commented May 11, 2026

Objective

  • Tiny Mwriting Monday contribution.
  • Improve Single doc example to show into_inner and filter usage.
  • Fix a typo and formatting for Query requires.

-- "fer" is "for"
-- Change use of "requires" into "`require`s" because, otherwise,
in these sentences it scans as a verb and forces a mental reparse.
Copy link
Copy Markdown
Contributor

@SpecificProtagonist SpecificProtagonist left a comment

Choose a reason for hiding this comment

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

Could maybe also add a filter to the example.

This calls attention to the (absolutely vital) `into_inner` method
that's the stumbling block once a Single query evolves to wrap
multiple mutable items.

(I keep forgetting this when converting `Query` to `Single`
and fight the compiler in all the expected wrong ways before
grepping the source to find how it's supposed to be used.
Hopefully this helps others!)
@eswartz eswartz force-pushed the minor-doc-fixes branch from a627397 to 3b1b8ab Compare May 11, 2026 15:56
@eswartz
Copy link
Copy Markdown
Contributor Author

eswartz commented May 11, 2026

Could maybe also add a filter to the example.

Do you mean in order to make it clearer that it's just like a Query?

@eswartz eswartz marked this pull request as draft May 11, 2026 16:16
@eswartz eswartz marked this pull request as ready for review May 11, 2026 16:32
@kfc35 kfc35 added C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it A-ECS Entities, components, systems, and events labels May 12, 2026
@github-project-automation github-project-automation Bot moved this to Needs SME Triage in ECS May 12, 2026
@kfc35 kfc35 added the D-Straightforward Simple bug fixes and API improvements, docs, test and examples label May 12, 2026
@alice-i-cecile alice-i-cecile added this to the 0.19 milestone May 13, 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 a399db0 May 13, 2026
46 checks passed
@github-project-automation github-project-automation Bot moved this from Needs SME Triage to Done in ECS May 13, 2026
mockersf pushed a commit to mockersf/bevy that referenced this pull request May 21, 2026
# Objective

- Tiny Mwriting Monday contribution.
- Improve `Single` doc example to show `into_inner` and filter usage.
- Fix a typo and formatting for Query `require`s.
mockersf pushed a commit that referenced this pull request May 21, 2026
# Objective

- Tiny Mwriting Monday contribution.
- Improve `Single` doc example to show `into_inner` and filter usage.
- Fix a typo and formatting for Query `require`s.
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 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

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants