From fbc4532c7aacf5f90e86fd28972e09e8bcda1f05 Mon Sep 17 00:00:00 2001 From: Jonas Bushart Date: Thu, 12 Sep 2024 23:11:41 +0200 Subject: [PATCH] Add crate docs to test cases More warnings appear after https://github.com/rust-lang/rust/pull/130025 --- serde_with/tests/base64.rs | 1 + serde_with/tests/chrono_0_4.rs | 2 ++ serde_with/tests/derives/lib.rs | 2 ++ serde_with/tests/hashbrown_0_14.rs | 2 ++ serde_with/tests/hex.rs | 2 ++ serde_with/tests/indexmap_1.rs | 2 ++ serde_with/tests/indexmap_2.rs | 2 ++ serde_with/tests/json.rs | 2 ++ serde_with/tests/rust.rs | 2 ++ serde_with/tests/schemars_0_8.rs | 2 ++ serde_with/tests/serde_as/lib.rs | 2 ++ serde_with/tests/time_0_3.rs | 2 ++ serde_with/tests/utils.rs | 2 +- serde_with/tests/version_numbers.rs | 2 ++ serde_with/tests/with_prefix.rs | 2 ++ serde_with_macros/tests/apply.rs | 2 ++ serde_with_macros/tests/compiler-messages.rs | 2 ++ serde_with_macros/tests/serde_as_issue_267.rs | 2 ++ serde_with_macros/tests/skip_serializing_null.rs | 2 ++ serde_with_macros/tests/version_numbers.rs | 2 ++ 20 files changed, 38 insertions(+), 1 deletion(-) diff --git a/serde_with/tests/base64.rs b/serde_with/tests/base64.rs index 1541d120..d4f52918 100644 --- a/serde_with/tests/base64.rs +++ b/serde_with/tests/base64.rs @@ -1,3 +1,4 @@ +//! Test Cases #![allow( // This allows the tests to be written more uniform and not have to special case the last clone(). clippy::redundant_clone, diff --git a/serde_with/tests/chrono_0_4.rs b/serde_with/tests/chrono_0_4.rs index 5dd72b43..8817f384 100644 --- a/serde_with/tests/chrono_0_4.rs +++ b/serde_with/tests/chrono_0_4.rs @@ -1,3 +1,5 @@ +//! Test Cases + extern crate alloc; mod utils; diff --git a/serde_with/tests/derives/lib.rs b/serde_with/tests/derives/lib.rs index 9a2b6a9e..4a250b98 100644 --- a/serde_with/tests/derives/lib.rs +++ b/serde_with/tests/derives/lib.rs @@ -1,3 +1,5 @@ +//! Test Cases + mod deserialize_fromstr; mod serialize_display; #[path = "../utils.rs"] diff --git a/serde_with/tests/hashbrown_0_14.rs b/serde_with/tests/hashbrown_0_14.rs index 57c06eae..1305ccba 100644 --- a/serde_with/tests/hashbrown_0_14.rs +++ b/serde_with/tests/hashbrown_0_14.rs @@ -1,3 +1,5 @@ +//! Test Cases + mod utils; use crate::utils::{check_deserialization, check_error_deserialization, is_equal}; diff --git a/serde_with/tests/hex.rs b/serde_with/tests/hex.rs index 0516ce68..7bd64aa5 100644 --- a/serde_with/tests/hex.rs +++ b/serde_with/tests/hex.rs @@ -1,3 +1,5 @@ +//! Test Cases + mod utils; use crate::utils::{check_deserialization, check_error_deserialization, is_equal}; diff --git a/serde_with/tests/indexmap_1.rs b/serde_with/tests/indexmap_1.rs index 10d92dbc..1f3db7dc 100644 --- a/serde_with/tests/indexmap_1.rs +++ b/serde_with/tests/indexmap_1.rs @@ -1,3 +1,5 @@ +//! Test Cases + mod utils; use crate::utils::{check_deserialization, check_error_deserialization, is_equal}; diff --git a/serde_with/tests/indexmap_2.rs b/serde_with/tests/indexmap_2.rs index 0128825c..5cb04e23 100644 --- a/serde_with/tests/indexmap_2.rs +++ b/serde_with/tests/indexmap_2.rs @@ -1,3 +1,5 @@ +//! Test Cases + mod utils; use crate::utils::{check_deserialization, check_error_deserialization, is_equal}; diff --git a/serde_with/tests/json.rs b/serde_with/tests/json.rs index 9422e9b2..50713a19 100644 --- a/serde_with/tests/json.rs +++ b/serde_with/tests/json.rs @@ -1,3 +1,5 @@ +//! Test Cases + mod utils; use crate::utils::is_equal; diff --git a/serde_with/tests/rust.rs b/serde_with/tests/rust.rs index cfda7f0d..0cc1ebaa 100644 --- a/serde_with/tests/rust.rs +++ b/serde_with/tests/rust.rs @@ -1,3 +1,5 @@ +//! Test Cases + extern crate alloc; mod utils; diff --git a/serde_with/tests/schemars_0_8.rs b/serde_with/tests/schemars_0_8.rs index 4237aa4b..a6c923e8 100644 --- a/serde_with/tests/schemars_0_8.rs +++ b/serde_with/tests/schemars_0_8.rs @@ -1,3 +1,5 @@ +//! Test Cases + use crate::utils::{check_matches_schema, check_valid_json_schema}; use expect_test::expect_file; use schemars::JsonSchema; diff --git a/serde_with/tests/serde_as/lib.rs b/serde_with/tests/serde_as/lib.rs index 74cf32b4..24104161 100644 --- a/serde_with/tests/serde_as/lib.rs +++ b/serde_with/tests/serde_as/lib.rs @@ -1,3 +1,5 @@ +//! Test Cases + extern crate alloc; mod collections; diff --git a/serde_with/tests/time_0_3.rs b/serde_with/tests/time_0_3.rs index 6723fcd8..e55ff9d7 100644 --- a/serde_with/tests/time_0_3.rs +++ b/serde_with/tests/time_0_3.rs @@ -1,3 +1,5 @@ +//! Test Cases + mod utils; use crate::utils::{check_deserialization, check_error_deserialization, is_equal}; diff --git a/serde_with/tests/utils.rs b/serde_with/tests/utils.rs index 5098f2d8..7eb50bd2 100644 --- a/serde_with/tests/utils.rs +++ b/serde_with/tests/utils.rs @@ -1,4 +1,4 @@ -#![allow(dead_code)] +#![allow(dead_code, missing_docs)] use core::fmt::Debug; use expect_test::Expect; diff --git a/serde_with/tests/version_numbers.rs b/serde_with/tests/version_numbers.rs index 44cd3109..d9b61f42 100644 --- a/serde_with/tests/version_numbers.rs +++ b/serde_with/tests/version_numbers.rs @@ -1,3 +1,5 @@ +//! Test Cases + use version_sync::{assert_contains_regex, assert_html_root_url_updated}; #[test] diff --git a/serde_with/tests/with_prefix.rs b/serde_with/tests/with_prefix.rs index 2bf9e1d7..7ec6a1fb 100644 --- a/serde_with/tests/with_prefix.rs +++ b/serde_with/tests/with_prefix.rs @@ -1,3 +1,5 @@ +//! Test Cases + extern crate alloc; mod utils; diff --git a/serde_with_macros/tests/apply.rs b/serde_with_macros/tests/apply.rs index 33b72132..b76f3922 100644 --- a/serde_with_macros/tests/apply.rs +++ b/serde_with_macros/tests/apply.rs @@ -1,3 +1,5 @@ +//! Test Cases + #![allow(dead_code)] use expect_test::expect; diff --git a/serde_with_macros/tests/compiler-messages.rs b/serde_with_macros/tests/compiler-messages.rs index bbb16c32..e7d7173f 100644 --- a/serde_with_macros/tests/compiler-messages.rs +++ b/serde_with_macros/tests/compiler-messages.rs @@ -1,3 +1,5 @@ +//! Test Cases + #[cfg_attr(tarpaulin, ignore)] // The error messages are different on beta and nightly, thus breaking the test. #[rustversion::attr(beta, ignore)] diff --git a/serde_with_macros/tests/serde_as_issue_267.rs b/serde_with_macros/tests/serde_as_issue_267.rs index 2db1bbea..92e06732 100644 --- a/serde_with_macros/tests/serde_as_issue_267.rs +++ b/serde_with_macros/tests/serde_as_issue_267.rs @@ -1,3 +1,5 @@ +#![allow(missing_docs)] + use serde::Serialize; use serde_with_macros::serde_as; diff --git a/serde_with_macros/tests/skip_serializing_null.rs b/serde_with_macros/tests/skip_serializing_null.rs index dc48334b..b6efac01 100644 --- a/serde_with_macros/tests/skip_serializing_null.rs +++ b/serde_with_macros/tests/skip_serializing_null.rs @@ -1,3 +1,5 @@ +//! Test Cases + use pretty_assertions::assert_eq; use serde::{Deserialize, Serialize}; use serde_json::json; diff --git a/serde_with_macros/tests/version_numbers.rs b/serde_with_macros/tests/version_numbers.rs index b68030d2..da4c6f03 100644 --- a/serde_with_macros/tests/version_numbers.rs +++ b/serde_with_macros/tests/version_numbers.rs @@ -1,3 +1,5 @@ +//! Test Cases + #[test] fn test_html_root_url() { version_sync::assert_html_root_url_updated!("src/lib.rs");