From 13a52b709ff945b6f026da06eb104c6b33248224 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois?= Date: Tue, 13 Apr 2021 17:18:47 +0000 Subject: [PATCH] markdown lint on CHANGELOG.md and examples/READE.md (#1906) new lints after #1783, fixes current CI break --- CHANGELOG.md | 51 +++++++++++++++++++++++----------------------- examples/README.md | 4 ++-- 2 files changed, 27 insertions(+), 28 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fec01e30092c3b..12ae3389c93f8c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,16 +24,16 @@ current changes on git with [previous release tags][git_tag_comparison]. - [3D OrthographicProjection improvements + new example][1361] - [Flexible camera bindings][1689] - [Render text in 2D scenes][1122] -- [Text2d render quality][1171] +- [`Text2d` render quality][1171] - [System sets and run criteria v2][1675] - [System sets and parallel executor v2][1144] - [Many-to-many system labels][1576] - [Non-string labels (#1423 continued)][1473] -- [Make EventReader a SystemParam][1244] -- [Add EventWriter][1575] +- [Make `EventReader` a `SystemParam`][1244] +- [Add `EventWriter`][1575] - [Reliable change detection][1471] - [Redo State architecture][1424] -- [Query::get_unique][1263] +- [`Query::get_unique`][1263] - [gltf: load normal and occlusion as linear textures][1762] - [Add separate brightness field to AmbientLight][1605] - [world coords to screen space][1258] @@ -47,10 +47,10 @@ current changes on git with [previous release tags][git_tag_comparison]. - [enable wgpu device features][547] - [Subpixel text positioning][1196] - [make more information available from loaded GLTF model][1020] -- [use Name on node when loading a gltf file][1183] +- [use `Name` on node when loading a gltf file][1183] - [GLTF loader: support mipmap filters][1639] - [Add support for gltf::Material::unlit][1341] -- [Implement Reflect for tuples up to length 12][1218] +- [Implement `Reflect` for tuples up to length 12][1218] - [Process Asset File Extensions With Multiple Dots][1277] - [Update Scene Example to Use scn.ron File][1339] - [3d game example][1252] @@ -58,37 +58,37 @@ current changes on git with [previous release tags][git_tag_comparison]. - [Count number of times a repeating Timer wraps around in a tick][1112] - [recycle `Timer` refactor to duration.sparkles Add `Stopwatch` struct.][1151] - [add scene instance entity iteration][1058] -- [Make Commands and World apis consistent][1703] -- [Add `insert_children` and `push_children` to EntityMut][1728] -- [Extend AppBuilder api with `add_system_set` and similar methods][1453] -- [add labels and ordering for transform and parent systems in POST_UPDATE stage][1456] +- [Make `Commands` and `World` apis consistent][1703] +- [Add `insert_children` and `push_children` to `EntityMut`][1728] +- [Extend `AppBuilder` api with `add_system_set` and similar methods][1453] +- [add labels and ordering for transform and parent systems in `POST_UPDATE` stage][1456] - [Explicit execution order ambiguities API][1469] - [Resolve (most) internal system ambiguities][1606] - [Change 'components' to 'bundles' where it makes sense semantically][1257] - [add `Flags` as a query to get flags of component][1172] -- [Rename add_resource to insert_resource][1356] -- [Update init_resource to not overwrite][1349] +- [Rename `add_resource` to `insert_resource`][1356] +- [Update `init_resource` to not overwrite][1349] - [Enable dynamic mutable access to component data][1284] -- [Get rid of ChangedRes][1313] -- [impl SystemParam for Option> / Option>][1494] +- [Get rid of `ChangedRes`][1313] +- [impl `SystemParam` for `Option>` / `Option>`][1494] - [Add Window Resize Constraints][1409] - [Add basic file drag and drop support][1096] -- [Modify Derive to allow unit structs for RenderResources.][1089] +- [Modify Derive to allow unit structs for `RenderResources`.][1089] - [bevy_render: load .spv assets][1104] - [Expose wgpu backend in WgpuOptions and allow it to be configured from the environment][1042] - [updates on diagnostics (log + new diagnostics)][1085] - [enable change detection for labels][1155] - [Name component with fast comparisons][1109] -- [Support for !Send tasks][1216] -- [Add missing spawn_local method to Scope in the single threaded executor case][1266] +- [Support for `!Send` tasks][1216] +- [Add missing `spawn_local` method to `Scope` in the single threaded executor case][1266] - [Add bmp as a supported texture format][1081] - [Add an alternative winit runner that can be started when not on the main thread][1063] -- [Added use_dpi setting to WindowDescriptor][1131] -- [Implement Copy for ElementState][1154] -- [Mutable mesh accessors: indices_mut and attribute_mut][1164] +- [Added `use_dpi` setting to `WindowDescriptor`][1131] +- [Implement `Copy` for `ElementState`][1154] +- [Mutable mesh accessors: `indices_mut` and `attribute_mut`][1164] - [Add support for OTF fonts][1200] - [Add `from_xyz` to `Transform`][1212] -- [Adding copy_texture_to_buffer and copy_texture_to_texture][1236] +- [Adding `copy_texture_to_buffer` and `copy_texture_to_texture`][1236] - [Added `set_minimized` and `set_position` to `Window`][1292] - [Example for 2D Frustum Culling][1503] - [Add remove resource to commands][1478] @@ -100,13 +100,13 @@ current changes on git with [previous release tags][git_tag_comparison]. - [color spaces and representation][1572] - [Make vertex buffers optional][1485] - [add to lower case to make asset loading case insensitive][1427] -- [Replace right/up/forward and counter parts with local_x/local_y and local_z][1476] -- [Use valid keys to initialize AHasher in FixedState][1268] -- [Change Name to take Into instead of String][1283] +- [Replace right/up/forward and counter parts with `local_x`/`local_y` and `local_z`][1476] +- [Use valid keys to initialize `AHasher` in `FixedState`][1268] +- [Change `Name` to take `Into` instead of `String`][1283] - [Update to wgpu-rs 0.7][542] - [Update glam to 0.13.0.][1550] - [use std clamp instead of Bevy's][1644] -- [Make Reflect impls unsafe (Reflect::any must return `self`)][1679] +- [Make `Reflect` impls unsafe (`Reflect::any` must return `self`)][1679] ### Fixed @@ -133,7 +133,6 @@ current changes on git with [previous release tags][git_tag_comparison]. - [Fix missing paths in ECS SystemParam derive macro][1434] - [Fix staging buffer required size calculation (fixes #1056)][1509] - [400]: https://github.com/bevyengine/bevy/pull/400 [542]: https://github.com/bevyengine/bevy/pull/542 [547]: https://github.com/bevyengine/bevy/pull/547 diff --git a/examples/README.md b/examples/README.md index 4cb046bc4829e4..15175765937f49 100644 --- a/examples/README.md +++ b/examples/README.md @@ -16,8 +16,8 @@ There are often large differences and incompatible API changes between the lates If you are using a released version of bevy, you need to make sure you are viewing the correct version of the examples! - - Latest release: [https://github.com/bevyengine/bevy/tree/latest/examples](https://github.com/bevyengine/bevy/tree/latest/examples) - - 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) +- Latest release: [https://github.com/bevyengine/bevy/tree/latest/examples](https://github.com/bevyengine/bevy/tree/latest/examples) +- 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) When you clone the repo locally to run the examples, use `git checkout` to get the correct version: