bevy_matchbox example header comments to include reference to cargo dependency changes when needed for integration. #465
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
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.
johanhelsing
requested changes
Nov 21, 2024
bevy_matchbox/examples/hello_host.rs
Outdated
| @@ -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, | |||
There was a problem hiding this comment.
What do you mean by cargo has been updated?
Also please add an empty line from the paragraph above, and keep the same indentation
bevy_matchbox/examples/hello_host.rs
Outdated
| @@ -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"] } | |||
There was a problem hiding this comment.
Code quotes should be surrounded by triple backticks, with toml as language
Added nuance to "cargo" -> cargo.toml file. Adjusted note indentation and spacing to match native format.
Reformatted to match native project and added nuance to reference to Cargo.
|
I've submitted a follow up commit for each file with improved formatting and additional nuance about the reference to the cargo.toml file. |
|
Did some final fixes, and a manual merge. Thanks for the PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a reference in the bevy_matchbox example's {hello_host, hello_signaling} comment header to advise updating the local Cargo.toml to enable the necessary features for seamless integration with the example logic.