bevyengine / bevyengine/bevy

Document ScheduleLabel dependencies

Open
#11,925 0 comments 0 reactions 0 assignees View on GitHub
A-ECS C-Docs
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 16h
Merged PRs (30d)
171

Description

## How can Bevy's documentation be improved?

The [ScheduleLabel derive macro](https://docs.rs/bevy/latest/bevy/ecs/schedule/derive.ScheduleLabel.html) requires that a type additionally implement `Hash, Debug, Eq, PartialEq, Clone`, but this is only evident when attempting and failing to compile a type missing these traits.

Contributor guide

Open the contributing guide

Research direction

Start with the ScheduleLabel derive macro documentation linked in the issue and inspect how its requirements are currently presented. Document that derived types must implement Hash, Debug, Eq, PartialEq, and Clone; done means the requirements are visible without needing to compile a failing example.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.