bevy/crates
BD103 4dcee649eb Improve Query's top-level documentation (#18622)
# Objective

- There's been several changes to `Query` for this release cycle, and
`Query`'s top-level documentation has gotten slightly out-of-date.
- Alternative to #18615.

## Solution

- Edit `Query`'s docs for consistency, clarity, and correctness.
- Make sure to group `get()` and `get_many()` together instead of
`single()` and `get_many()`, to enforce the distinction from
https://github.com/bevyengine/bevy/pull/18615#issuecomment-2764355672.
- Reformat doc tests so they would be readable if extracted into their
own file. (Which mainly involves adding more spacing.)
- Move link definitions to be nearer where they are used.
- Fix the tables so they are up-to-date and correctly escape square
brackets `\[ \]`.

## Testing

I ran `cargo doc -p bevy_ecs --no-deps` to view the docs and `cargo test
-p bevy_ecs --doc` to test the doc comments.

## Reviewing

The diff is difficult to read, so I don't recommend _just_ looking at
that. Instead, run `cargo doc -p bevy_ecs --no-deps` locally and read
through the new version. It should theoretically read smoother with less
super-technical jargon. :)

## Follow-up

I want to go through some of `Query`'s methods, such as `single()`,
`get()`, and `get_many()`, but I'll leave that for another PR.

---------

Co-authored-by: Chris Russell <8494645+chescock@users.noreply.github.com>
2025-03-31 22:33:27 +02:00
..
bevy_a11y
bevy_animation Fix animation transitions affecting other entities (#18572) 2025-03-27 22:58:21 +01:00
bevy_app Fix misleading documentation of Main schedule (#18579) 2025-03-28 23:33:00 +01:00
bevy_asset Only send unused event when final handle is dropped. (#18641) 2025-03-31 22:33:27 +02:00
bevy_audio
bevy_color
bevy_core_pipeline reexport entity set collections in entity module (#18413) 2025-03-30 10:24:00 +02:00
bevy_derive
bevy_dev_tools
bevy_diagnostic Fix LogDiagnosticsPlugin log target typo (#18534) 2025-03-30 10:21:19 +02:00
bevy_dylib
bevy_ecs Improve Query's top-level documentation (#18622) 2025-03-31 22:33:27 +02:00
bevy_encase_derive
bevy_gilrs reexport entity set collections in entity module (#18413) 2025-03-30 10:24:00 +02:00
bevy_gizmos Rename EntityBorrow/TrustedEntityBorrow to ContainsEntity/EntityEquivalent (#18470) 2025-03-30 10:24:00 +02:00
bevy_gltf reexport entity set collections in entity module (#18413) 2025-03-30 10:24:00 +02:00
bevy_image bevy_image: derive TypePath when Reflect is not available (#18501) 2025-03-30 10:23:55 +02:00
bevy_input
bevy_input_focus reexport entity set collections in entity module (#18413) 2025-03-30 10:24:00 +02:00
bevy_internal
bevy_log
bevy_macro_utils
bevy_math
bevy_mesh
bevy_mikktspace
bevy_pbr Fix mesh extraction for meshes without associated material. (#18631) 2025-03-31 22:33:27 +02:00
bevy_picking
bevy_platform_support
bevy_ptr
bevy_reflect bevy_reflect: Fix TypePath string concatenation (#18609) 2025-03-30 10:21:19 +02:00
bevy_remote
bevy_render Use GpuPreprocessingMode::None if features not supported. (#18630) 2025-03-31 22:33:27 +02:00
bevy_scene reexport entity set collections in entity module (#18413) 2025-03-30 10:24:00 +02:00
bevy_sprite Fix mesh tag feature for 2d. (#18636) 2025-03-31 22:33:27 +02:00
bevy_state Fix misleading documentation of Main schedule (#18579) 2025-03-28 23:33:00 +01:00
bevy_tasks
bevy_text reexport entity set collections in entity module (#18413) 2025-03-30 10:24:00 +02:00
bevy_time
bevy_transform Transform Propagation Optimization: Static Subtree Marking (#18589) 2025-03-30 10:21:20 +02:00
bevy_ui Rename EntityBorrow/TrustedEntityBorrow to ContainsEntity/EntityEquivalent (#18470) 2025-03-30 10:24:00 +02:00
bevy_utils
bevy_window Rename EntityBorrow/TrustedEntityBorrow to ContainsEntity/EntityEquivalent (#18470) 2025-03-30 10:24:00 +02:00
bevy_winit reexport entity set collections in entity module (#18413) 2025-03-30 10:24:00 +02:00