Skip to content

Commit

Permalink
feat: add section on known issues
Browse files Browse the repository at this point in the history
  • Loading branch information
BD103 committed Sep 27, 2024
1 parent da93d8a commit ebb5079
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions bevy_lint/src/lints/plugin_not_ending_in_plugin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@
//! `Plugin` is to be a Bevy plugin. As such, it is common practice to suffix plugin names with
//! "Plugin" to signal how they should be used.
//!
//! # Known issues
//!
//! Due to technical reasons, if you wish to silence this lint you need to annotate the
//! `impl Plugin for T` line with `#[allow(bevy::plugin_not_ending_in_plugin)]`, not the `struct T`
//! line.
//!
//! # Example
//!
//! ```
Expand Down

0 comments on commit ebb5079

Please sign in to comment.