From 51faa1b0b906abeb8c2de3ff78023d24207dbfd1 Mon Sep 17 00:00:00 2001 From: CodyTheDoer <58911083+CodyTheDoer@users.noreply.github.com> Date: Wed, 20 Nov 2024 11:32:07 -0500 Subject: [PATCH 1/5] Update hello_host.rs Added a reference in the example's comment header to advise updating the local Cargo.toml to enable the necessary features for seamless integration with the example logic. --- bevy_matchbox/examples/hello_host.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/bevy_matchbox/examples/hello_host.rs b/bevy_matchbox/examples/hello_host.rs index 056c3d2b..a9b06330 100644 --- a/bevy_matchbox/examples/hello_host.rs +++ b/bevy_matchbox/examples/hello_host.rs @@ -1,4 +1,7 @@ //! Runs both signaling with server/client topology and runs the host in the same process +//! Note: When building a signaling server ensure your cargo has been updated, +//! Enable the `signaling` feature in the `bevy_matchbox` dependency: +//! bevy_matchbox = { version = "0.n", features = ["signaling"] } //! //! Sends messages periodically to all connected clients. From 1bcf7206ea59c217c86567bd579deb9813bea719 Mon Sep 17 00:00:00 2001 From: CodyTheDoer <58911083+CodyTheDoer@users.noreply.github.com> Date: Wed, 20 Nov 2024 11:32:59 -0500 Subject: [PATCH 2/5] Update hello_signaling.rs Added a reference in the example's comment header to advise updating the local Cargo.toml to enable the necessary features for seamless integration with the example logic. --- bevy_matchbox/examples/hello_signaling.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/bevy_matchbox/examples/hello_signaling.rs b/bevy_matchbox/examples/hello_signaling.rs index 7126f3b3..97005056 100644 --- a/bevy_matchbox/examples/hello_signaling.rs +++ b/bevy_matchbox/examples/hello_signaling.rs @@ -1,5 +1,8 @@ //! Runs a signaling server with server/client topology as a headless bevy //! application. +//! Note: When building a signaling server ensure your cargo has been updated, +//! Enable the `signaling` feature in the `bevy_matchbox` dependency: +//! bevy_matchbox = { version = "0.n", features = ["signaling"] } use bevy::{app::ScheduleRunnerPlugin, log::LogPlugin, prelude::*, utils::Duration}; use bevy_matchbox::{matchbox_signaling::SignalingServer, prelude::*}; From 0fab57a1ad52ee40bfbf92624d66ab989a0daf77 Mon Sep 17 00:00:00 2001 From: CodyTheDoer <58911083+CodyTheDoer@users.noreply.github.com> Date: Tue, 10 Dec 2024 11:43:19 -0500 Subject: [PATCH 3/5] Update hello_host.rs header Added nuance to "cargo" -> cargo.toml file. Adjusted note indentation and spacing to match native format. --- bevy_matchbox/examples/hello_host.rs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/bevy_matchbox/examples/hello_host.rs b/bevy_matchbox/examples/hello_host.rs index a9b06330..8d51a793 100644 --- a/bevy_matchbox/examples/hello_host.rs +++ b/bevy_matchbox/examples/hello_host.rs @@ -1,9 +1,10 @@ //! Runs both signaling with server/client topology and runs the host in the same process -//! Note: When building a signaling server ensure your cargo has been updated, -//! Enable the `signaling` feature in the `bevy_matchbox` dependency: -//! bevy_matchbox = { version = "0.n", features = ["signaling"] } //! //! Sends messages periodically to all connected clients. +//! +//! Note: When building a signaling server ensure your project cargo.toml file has been updated with +//! the appropriate dependencies. When building a signaling server, enable the `signaling` feature: +//! ```toml bevy_matchbox = { version = "0.n", features = ["signaling"] }``` use bevy::{ app::ScheduleRunnerPlugin, log::LogPlugin, prelude::*, time::common_conditions::on_timer, From ffab55eea2326cf0917d45a0f52f2dfabdd04df0 Mon Sep 17 00:00:00 2001 From: CodyTheDoer <58911083+CodyTheDoer@users.noreply.github.com> Date: Tue, 10 Dec 2024 11:46:46 -0500 Subject: [PATCH 4/5] Update hello_signaling.rs Reformatted to match native project and added nuance to reference to Cargo. --- bevy_matchbox/examples/hello_signaling.rs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/bevy_matchbox/examples/hello_signaling.rs b/bevy_matchbox/examples/hello_signaling.rs index 97005056..0f8f1766 100644 --- a/bevy_matchbox/examples/hello_signaling.rs +++ b/bevy_matchbox/examples/hello_signaling.rs @@ -1,8 +1,9 @@ //! Runs a signaling server with server/client topology as a headless bevy //! application. -//! Note: When building a signaling server ensure your cargo has been updated, -//! Enable the `signaling` feature in the `bevy_matchbox` dependency: -//! bevy_matchbox = { version = "0.n", features = ["signaling"] } +//! +//! Note: When building a signaling server ensure your project cargo.toml file has been updated with +//! the appropriate dependencies. When building a signaling server, enable the `signaling` feature: +//! ```toml bevy_matchbox = { version = "0.n", features = ["signaling"] }``` use bevy::{app::ScheduleRunnerPlugin, log::LogPlugin, prelude::*, utils::Duration}; use bevy_matchbox::{matchbox_signaling::SignalingServer, prelude::*}; From d6c6ff50bfe372c80b966150b878f8cfdb96d758 Mon Sep 17 00:00:00 2001 From: Johan Klokkhammer Helsing Date: Thu, 12 Dec 2024 09:08:20 +0100 Subject: [PATCH 5/5] docs: Fix formatting and wording issues --- bevy_matchbox/examples/hello_host.rs | 11 +++++++---- bevy_matchbox/examples/hello_signaling.rs | 11 +++++++---- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/bevy_matchbox/examples/hello_host.rs b/bevy_matchbox/examples/hello_host.rs index 8d51a793..27170b3f 100644 --- a/bevy_matchbox/examples/hello_host.rs +++ b/bevy_matchbox/examples/hello_host.rs @@ -1,10 +1,13 @@ //! Runs both signaling with server/client topology and runs the host in the same process //! //! Sends messages periodically to all connected clients. -//! -//! Note: When building a signaling server ensure your project cargo.toml file has been updated with -//! the appropriate dependencies. When building a signaling server, enable the `signaling` feature: -//! ```toml bevy_matchbox = { version = "0.n", features = ["signaling"] }``` +//! +//! Note: When building a signaling server make sure you depend on +//! `bevy_matchbox` with the `signaling` feature enabled. +//! +//! ```toml +//! bevy_matchbox = { version = "0.x", features = ["signaling"] } +//! ``` use bevy::{ app::ScheduleRunnerPlugin, log::LogPlugin, prelude::*, time::common_conditions::on_timer, diff --git a/bevy_matchbox/examples/hello_signaling.rs b/bevy_matchbox/examples/hello_signaling.rs index 0f8f1766..4073e678 100644 --- a/bevy_matchbox/examples/hello_signaling.rs +++ b/bevy_matchbox/examples/hello_signaling.rs @@ -1,9 +1,12 @@ //! Runs a signaling server with server/client topology as a headless bevy //! application. -//! -//! Note: When building a signaling server ensure your project cargo.toml file has been updated with -//! the appropriate dependencies. When building a signaling server, enable the `signaling` feature: -//! ```toml bevy_matchbox = { version = "0.n", features = ["signaling"] }``` +//! +//! Note: When building a signaling server make sure you depend on +//! `bevy_matchbox` with the `signaling` feature enabled. +//! +//! ```toml +//! bevy_matchbox = { version = "0.x", features = ["signaling"] } +//! ``` use bevy::{app::ScheduleRunnerPlugin, log::LogPlugin, prelude::*, utils::Duration}; use bevy_matchbox::{matchbox_signaling::SignalingServer, prelude::*};