Put ClientDiagnosticsPlugin under diagnostics feature
#295
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
And make it part of the `RepliconPlugins` group.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## 0.14.0-rc #295 +/- ##
=============================================
+ Coverage 90.94% 90.96% +0.02%
=============================================
Files 38 37 -1
Lines 2329 2202 -127
=============================================
- Hits 2118 2003 -115
+ Misses 211 199 -12 ☔ View full report in Codecov by Sentry. |
UkoeHB
requested changes
Jun 25, 2024
Comment on lines
+646
to
+647
| /// Statistic will be collected only if the resource is present. | ||
| /// The resource is not added by default. |
There was a problem hiding this comment.
Suggested change
| /// Statistic will be collected only if the resource is present. | |
| /// The resource is not added by default. | |
| /// Statistic will be collected only if the resource is present. | |
| /// The resource is not added by default. See [`ClientDiagnosticsPlugin`]. |
There was a problem hiding this comment.
I thought about it, but it's under a feature :(
If I link to it, cargo doc --open will emit a warning about missing link. I will need to enable the feature explicitly in CLI to generate docs without warnings.
Maybe you know a way to conditionally include docs?
There was a problem hiding this comment.
Added. I will just always run --all-features for cargo doc to avoid warnings. Discoverability is important.
There was a problem hiding this comment.
Maybe you know a way to conditionally include docs?
You should be able to get all docs with this (and also get the nice feature-requirement message in docs):
# Cargo.toml
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]#[cfg_attr(docsrs, doc(cfg(feature = "diagnostics")))]
pub mod diagnostics;There was a problem hiding this comment.
Thanks, done!
I used doc_auto_cfg, like Bevy does:
bevyengine/bevy#12366
bevyengine/bevy#12642
This separation makes more sense to me and allows me to require a feature for running `diagnostics` test.
UkoeHB
approved these changes
Jun 26, 2024
Shatur
added a commit
that referenced
this pull request
Jul 4, 2024
* Update to 0.14.0-rc.2 * Temporary disable CI for bevy_replicon_renet * Minor stylistic changes Just a few spaces and an intermediate veriable to make the code look a little bit nicer. * Bump version to 0.27.0-rc.1 * Remove bevy_replicon_renet from workspace * Bump version to 0.27.0-rc.2 * Undo changes in bevy_replicon_renet [skip ci] * Rework events organization - Swap `receive` system between ServerEventsPlugin and `ClientEventsPlugin` to properly separate what what runs on client or server. - Move `ServerEventsPlugin::reset` logic inside `ClientEventsPlugin::reset` because this logic runs on client. - Move `server::events::event_data` module to `core::event_registry::server_event`. - Move `client::events::event_data` module to `core::event_registry::client_event`. No functional changes, except `ServerEventsPlugin` and `ClientEventsPlugin` can be disabled on client-only and server-only apps respectively. Closes #276. * Do not divide values per seconds by the number of messages * Update changelog [skip ci] * Put `ClientDiagnosticsPlugin` under `diagnostics` feature (#295) * Put `scene` module under `scene` feature (enabled by default) * Put `parent_sync` module under `parent_sync` feature * Client-server-features (#298) * Use GitHub's warning about semver compatibility https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts * Document features better I took inspiration from Bevy. * Update src/lib.rs * Move `bevy_replicon_renet` to a dedicated repository * Bump version to 0.27.0-rc.3 * Fix copy-paste * Speedup removals caching The necessary method was provided in 0.14. * Remove mentions of the RC Without it it will be quite hard to read the changelog (users will have to check the changes from RC) or I will need to copy all changes from RC for the upcoming 0.27.0. I also removed it from the compatibility table as suggested by @UkoeHB. I also don't think that they will be useful... Keeping them will make the table harder to read. Another option would be to keep them, but put under a spoiler. --------- Co-authored-by: UkoeHB <37489173+UkoeHB@users.noreply.github.com>
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.
And make it part of the
RepliconPluginsgroup.It makes it much more discoverable. Planning to put under features
scene,parent_sync,clientandserveras well in next PRs. Like Bevy does.