Skip to content

Commit

Permalink
Fix plugin table (#565)
Browse files Browse the repository at this point in the history
# Objective

The plugin table for the docs of `PhysicsPlugins` mentions `PhysicsDebugPlugin` as a plugin that is added by default, but it isn't. `PhysicsPickingPlugin` on the other hand isn't mentioned at all.

## Solution

Add a separate table for additional plugins.
  • Loading branch information
Jondolf authored Nov 25, 2024
1 parent 6370ce6 commit f951ed3
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,13 @@ use prelude::*;
/// | [`SleepingPlugin`] | Manages sleeping and waking for bodies, automatically deactivating them to save computational resources. |
/// | [`SpatialQueryPlugin`] | Handles spatial queries like [raycasting](spatial_query#raycasting) and [shapecasting](spatial_query#shapecasting). |
/// | [`SyncPlugin`] | Keeps [`Position`] and [`Rotation`] in sync with `Transform`. |
///
/// Optional additional plugins include:
///
/// | Plugin | Description |
/// | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
/// | [`PhysicsDebugPlugin`] | Renders physics objects and events like [AABBs](ColliderAabb) and [contacts](Collision) for debugging purposes (only with `debug-plugin` feature enabled). |
/// | [`PhysicsPickingPlugin`] | Enables a physics picking backend for [`bevy_picking`](bevy::picking) (only with `bevy_picking` feature enabled). |
///
/// Refer to the documentation of the plugins for more information about their responsibilities and implementations.
///
Expand Down

0 comments on commit f951ed3

Please sign in to comment.