bevyengine / bevyengine/bevy

Documentation of preludes is handled inconsistently

Open
#6,450 1 comment 0 reactions 0 assignees View on GitHub
C-Docs
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?

> - bevy_time has nothing on the prelude module, and doc hidden on the reexports. this seems to be the most common case
> - bevy_transform has doc hidden on the prelude and on the reexports. there are a handful of crates that way

- @mockersf

Our goals here:
- multiple copies of the same item should not appear in the docs: only the canonical path should appear
- users should be able to see what's in the preludes

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.