bevyengine / bevyengine/bevy

`MeshPickingPlugin` is not mentioned in the module doc

Open
#19,458 0 comments 0 reactions 0 assignees View on GitHub
A-Picking C-Docs D-Straightforward S-Ready-For-Implementation
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 22h
Merged PRs (30d)
161

Description

## How can Bevy's documentation be improved?

The `bevy_picking` [module doc](https://docs.rs/bevy/latest/bevy/picking/index.html) doesn't mention anywhere the `MeshPickingPlugin`, which is critical not only for 3D meshes but also for 2D ones, because:

- that plugin is not added by default
- 2D meshes are different from sprites, so require the `MeshPickingPlugin`

The result is that spawning a `Mesh2d` + `PickingInteraction` does nothing, and the user can't understand why from docs.

In fact, even for 3D meshes, that top-level module documentation never mentions this plugin, despite the fact the doc does refer to mesh picking.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.