Skip to content

Commit dae8357

Browse files
committed
markdown lint on CHANGELOG.md and examples/READE.md (#1906)
new lints after #1783, fixes current CI break
1 parent 7342d46 commit dae8357

File tree

2 files changed

+27
-28
lines changed

2 files changed

+27
-28
lines changed

CHANGELOG.md

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,16 @@ current changes on git with [previous release tags][git_tag_comparison].
2424
- [3D OrthographicProjection improvements + new example][1361]
2525
- [Flexible camera bindings][1689]
2626
- [Render text in 2D scenes][1122]
27-
- [Text2d render quality][1171]
27+
- [`Text2d` render quality][1171]
2828
- [System sets and run criteria v2][1675]
2929
- [System sets and parallel executor v2][1144]
3030
- [Many-to-many system labels][1576]
3131
- [Non-string labels (#1423 continued)][1473]
32-
- [Make EventReader a SystemParam][1244]
33-
- [Add EventWriter][1575]
32+
- [Make `EventReader` a `SystemParam`][1244]
33+
- [Add `EventWriter`][1575]
3434
- [Reliable change detection][1471]
3535
- [Redo State architecture][1424]
36-
- [Query::get_unique][1263]
36+
- [`Query::get_unique`][1263]
3737
- [gltf: load normal and occlusion as linear textures][1762]
3838
- [Add separate brightness field to AmbientLight][1605]
3939
- [world coords to screen space][1258]
@@ -47,48 +47,48 @@ current changes on git with [previous release tags][git_tag_comparison].
4747
- [enable wgpu device features][547]
4848
- [Subpixel text positioning][1196]
4949
- [make more information available from loaded GLTF model][1020]
50-
- [use Name on node when loading a gltf file][1183]
50+
- [use `Name` on node when loading a gltf file][1183]
5151
- [GLTF loader: support mipmap filters][1639]
5252
- [Add support for gltf::Material::unlit][1341]
53-
- [Implement Reflect for tuples up to length 12][1218]
53+
- [Implement `Reflect` for tuples up to length 12][1218]
5454
- [Process Asset File Extensions With Multiple Dots][1277]
5555
- [Update Scene Example to Use scn.ron File][1339]
5656
- [3d game example][1252]
5757
- [Add keyboard modifier example (#1656)][1657]
5858
- [Count number of times a repeating Timer wraps around in a tick][1112]
5959
- [recycle `Timer` refactor to duration.sparkles Add `Stopwatch` struct.][1151]
6060
- [add scene instance entity iteration][1058]
61-
- [Make Commands and World apis consistent][1703]
62-
- [Add `insert_children` and `push_children` to EntityMut][1728]
63-
- [Extend AppBuilder api with `add_system_set` and similar methods][1453]
64-
- [add labels and ordering for transform and parent systems in POST_UPDATE stage][1456]
61+
- [Make `Commands` and `World` apis consistent][1703]
62+
- [Add `insert_children` and `push_children` to `EntityMut`][1728]
63+
- [Extend `AppBuilder` api with `add_system_set` and similar methods][1453]
64+
- [add labels and ordering for transform and parent systems in `POST_UPDATE` stage][1456]
6565
- [Explicit execution order ambiguities API][1469]
6666
- [Resolve (most) internal system ambiguities][1606]
6767
- [Change 'components' to 'bundles' where it makes sense semantically][1257]
6868
- [add `Flags<T>` as a query to get flags of component][1172]
69-
- [Rename add_resource to insert_resource][1356]
70-
- [Update init_resource to not overwrite][1349]
69+
- [Rename `add_resource` to `insert_resource`][1356]
70+
- [Update `init_resource` to not overwrite][1349]
7171
- [Enable dynamic mutable access to component data][1284]
72-
- [Get rid of ChangedRes][1313]
73-
- [impl SystemParam for Option<Res<T>> / Option<ResMut<T>>][1494]
72+
- [Get rid of `ChangedRes`][1313]
73+
- [impl `SystemParam` for `Option<Res<T>>` / `Option<ResMut<T>>`][1494]
7474
- [Add Window Resize Constraints][1409]
7575
- [Add basic file drag and drop support][1096]
76-
- [Modify Derive to allow unit structs for RenderResources.][1089]
76+
- [Modify Derive to allow unit structs for `RenderResources`.][1089]
7777
- [bevy_render: load .spv assets][1104]
7878
- [Expose wgpu backend in WgpuOptions and allow it to be configured from the environment][1042]
7979
- [updates on diagnostics (log + new diagnostics)][1085]
8080
- [enable change detection for labels][1155]
8181
- [Name component with fast comparisons][1109]
82-
- [Support for !Send tasks][1216]
83-
- [Add missing spawn_local method to Scope in the single threaded executor case][1266]
82+
- [Support for `!Send` tasks][1216]
83+
- [Add missing `spawn_local` method to `Scope` in the single threaded executor case][1266]
8484
- [Add bmp as a supported texture format][1081]
8585
- [Add an alternative winit runner that can be started when not on the main thread][1063]
86-
- [Added use_dpi setting to WindowDescriptor][1131]
87-
- [Implement Copy for ElementState][1154]
88-
- [Mutable mesh accessors: indices_mut and attribute_mut][1164]
86+
- [Added `use_dpi` setting to `WindowDescriptor`][1131]
87+
- [Implement `Copy` for `ElementState`][1154]
88+
- [Mutable mesh accessors: `indices_mut` and `attribute_mut`][1164]
8989
- [Add support for OTF fonts][1200]
9090
- [Add `from_xyz` to `Transform`][1212]
91-
- [Adding copy_texture_to_buffer and copy_texture_to_texture][1236]
91+
- [Adding `copy_texture_to_buffer` and `copy_texture_to_texture`][1236]
9292
- [Added `set_minimized` and `set_position` to `Window`][1292]
9393
- [Example for 2D Frustum Culling][1503]
9494
- [Add remove resource to commands][1478]
@@ -100,13 +100,13 @@ current changes on git with [previous release tags][git_tag_comparison].
100100
- [color spaces and representation][1572]
101101
- [Make vertex buffers optional][1485]
102102
- [add to lower case to make asset loading case insensitive][1427]
103-
- [Replace right/up/forward and counter parts with local_x/local_y and local_z][1476]
104-
- [Use valid keys to initialize AHasher in FixedState][1268]
105-
- [Change Name to take Into<String> instead of String][1283]
103+
- [Replace right/up/forward and counter parts with `local_x`/`local_y` and `local_z`][1476]
104+
- [Use valid keys to initialize `AHasher` in `FixedState`][1268]
105+
- [Change `Name` to take `Into<String>` instead of `String`][1283]
106106
- [Update to wgpu-rs 0.7][542]
107107
- [Update glam to 0.13.0.][1550]
108108
- [use std clamp instead of Bevy's][1644]
109-
- [Make Reflect impls unsafe (Reflect::any must return `self`)][1679]
109+
- [Make `Reflect` impls unsafe (`Reflect::any` must return `self`)][1679]
110110

111111
### Fixed
112112

@@ -133,7 +133,6 @@ current changes on git with [previous release tags][git_tag_comparison].
133133
- [Fix missing paths in ECS SystemParam derive macro][1434]
134134
- [Fix staging buffer required size calculation (fixes #1056)][1509]
135135

136-
137136
[400]: https://github.com/bevyengine/bevy/pull/400
138137
[542]: https://github.com/bevyengine/bevy/pull/542
139138
[547]: https://github.com/bevyengine/bevy/pull/547

examples/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ There are often large differences and incompatible API changes between the lates
1616

1717
If you are using a released version of bevy, you need to make sure you are viewing the correct version of the examples!
1818

19-
- Latest release: [https://github.com/bevyengine/bevy/tree/latest/examples](https://github.com/bevyengine/bevy/tree/latest/examples)
20-
- Specific version, such as `0.4`: [https://github.com/bevyengine/bevy/tree/v0.4.0/examples](https://github.com/bevyengine/bevy/tree/v0.4.0/examples)
19+
- Latest release: [https://github.com/bevyengine/bevy/tree/latest/examples](https://github.com/bevyengine/bevy/tree/latest/examples)
20+
- Specific version, such as `0.4`: [https://github.com/bevyengine/bevy/tree/v0.4.0/examples](https://github.com/bevyengine/bevy/tree/v0.4.0/examples)
2121

2222
When you clone the repo locally to run the examples, use `git checkout` to get the correct version:
2323

0 commit comments

Comments
 (0)