Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bevy_matchbox example header comments to include reference to cargo dependency changes when needed for integration. #465

Merged
merged 4 commits into from
Dec 12, 2024
Merged

bevy_matchbox example header comments to include reference to cargo dependency changes when needed for integration. #465

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
51faa1b
Update hello_host.rs
CodyTheDoer Nov 20, 2024
1bcf720
Update hello_signaling.rs
CodyTheDoer Nov 20, 2024
0fab57a
Update hello_host.rs header
CodyTheDoer Dec 10, 2024
ffab55e
Update hello_signaling.rs
CodyTheDoer Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions bevy_matchbox/examples/hello_host.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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,
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean by cargo has been updated?

Also please add an empty line from the paragraph above, and keep the same indentation

//! Enable the `signaling` feature in the `bevy_matchbox` dependency:
//! bevy_matchbox = { version = "0.n", features = ["signaling"] }
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code quotes should be surrounded by triple backticks, with toml as language

//!
//! Sends messages periodically to all connected clients.

Expand Down
3 changes: 3 additions & 0 deletions bevy_matchbox/examples/hello_signaling.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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::*};
Expand Down
Loading