Suggest using #[allow(clippy::all)] for bindings

Signed-off-by: Andrej Orsula <[email protected]>
AndrejOrsula · Jan 20, 2024 · a47ba4d · a47ba4d
1 parent 51c1e3b
commit a47ba4d
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -115,7 +115,12 @@ fn main() {
 Afterwards, include the generated bindings anywhere in your crate.
 
 ```rs
-#[allow(non_camel_case_types, non_snake_case, non_upper_case_globals)]
+#[allow(
+    clippy::all,
+    non_camel_case_types,
+    non_snake_case,
+    non_upper_case_globals
+)]
 pub mod target_module {
     include!(concat!(env!("OUT_DIR"), "/bindings.rs"));
 }
@@ -150,7 +155,12 @@ pyo3_bindgen = { version = "0.1", features = ["macros"] }
 Then, you can call the `import_python!` macro anywhere in your crate.
 
 ```rs
-#[allow(non_camel_case_types, non_snake_case, non_upper_case_globals)]
+#[allow(
+    clippy::all,
+    non_camel_case_types,
+    non_snake_case,
+    non_upper_case_globals
+)]
 pub mod target_module {
     pyo3_bindgen::import_python!("target_module");
 }

diff --git a/pyo3_bindgen/src/lib.rs b/pyo3_bindgen/src/lib.rs
@@ -32,7 +32,12 @@
 //! Afterwards, include the generated bindings anywhere in your crate.
 //!
 //! ```rs
-//! #[allow(non_camel_case_types, non_snake_case, non_upper_case_globals)]
+//! #[allow(
+//!     clippy::all,
+//!     non_camel_case_types,
+//!     non_snake_case,
+//!     non_upper_case_globals
+//! )]
 //! pub mod target_module {
 //!     include!(concat!(env!("OUT_DIR"), "/bindings.rs"));
 //! }
@@ -67,7 +72,12 @@
 //! Then, you can call the `import_python!` macro anywhere in your crate.
 //!
 //! ```rs
-//! #[allow(non_camel_case_types, non_snake_case, non_upper_case_globals)]
+//! #[allow(
+//!     clippy::all,
+//!     non_camel_case_types,
+//!     non_snake_case,
+//!     non_upper_case_globals
+//! )]
 //! pub mod target_module {
 //!     pyo3_bindgen::import_python!("target_module");
 //! }

diff --git a/pyo3_bindgen_engine/src/build_utils.rs b/pyo3_bindgen_engine/src/build_utils.rs
@@ -36,7 +36,12 @@
 /// ```ignore
 /// // src/lib.rs
 ///
-/// #[allow(non_camel_case_types, non_snake_case, non_upper_case_globals)]
+/// #[allow(
+///     clippy::all,
+///     non_camel_case_types,
+///     non_snake_case,
+///     non_upper_case_globals
+/// )]
 /// pub mod os {
 ///     include!(concat!(env!("OUT_DIR"), "/bindings.rs"));
 /// }

diff --git a/pyo3_bindgen_macros/src/lib.rs b/pyo3_bindgen_macros/src/lib.rs
@@ -14,12 +14,22 @@ mod parser;
 /// // use pyo3_bindgen::import_python;
 /// use pyo3_bindgen_macros::import_python;
 ///
-/// #[allow(non_camel_case_types, non_snake_case, non_upper_case_globals)]
+/// #[allow(
+///     clippy::all,
+///     non_camel_case_types,
+///     non_snake_case,
+///     non_upper_case_globals
+/// )]
 /// pub mod sys {
 ///    import_python!("sys");
 /// }
 ///
-/// #[allow(non_camel_case_types, non_snake_case, non_upper_case_globals)]
+/// #[allow(
+///     clippy::all,
+///     non_camel_case_types,
+///     non_snake_case,
+///     non_upper_case_globals
+/// )]
 /// pub(crate) mod os_path {
 ///    import_python!("os.path");
 /// }