Skip to content

Commit b3ae197

Browse files
Release notes for PR #17758: Trait tags on docs.rs (#2017)
1 parent 245767a commit b3ae197

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed
10.8 KB
Loading
Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
11
<!-- Trait tags on docs.rs -->
22
<!-- https://github.com/bevyengine/bevy/pull/17758 -->
33

4-
<!-- TODO -->
4+
Being a framework, Bevy provides several traits that define how a type is used – for example, to attach data to an entity, it must implement `Component`. When reading the docs, that meant scrolling down to the type's trait implementation section and searching for relevant traits. With 0.16 however, on docs.rs, Bevy displays labels indicating which relevant a type implements:
5+
![Rustdoc showing a "Component" label below "Camera" type](trait-tags.png)
6+
7+
This happens for the traits
8+
`Plugin` / `PluginGroup`,
9+
`Component`,
10+
`Resource`,
11+
`Asset`,
12+
`Event`,
13+
`ScheduleLabel`,
14+
`SystemSet`,
15+
`SystemParam`,
16+
`Relationship` and
17+
`RelationshipTarget`.
18+
19+
If you want to add these to your own crate, check out [these instructions](https://github.com/bevyengine/bevy/tree/release-0.16.0/docs-rs).

0 commit comments

Comments
 (0)