add doc

paradigmxyz · Aug 9, 2024 · fa365a6 · fa365a6
1 parent fe2c661
commit fa365a6
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/crates/storage/codecs/derive/src/lib.rs b/crates/storage/codecs/derive/src/lib.rs
@@ -144,6 +144,14 @@ impl Parse for GenerateTestsInput {
     }
 }
 
+/// Generates tests for given type based on passed parameters.
+///
+/// See `arbitrary::maybe_generate_tests` for more information.
+///
+/// Example usage:
+/// ```ignore
+/// generate_tests(#[rlp, compact], MyType, MyTypeTests)
+/// ```
 #[proc_macro]
 pub fn generate_tests(input: TokenStream) -> TokenStream {
     let input = parse_macro_input!(input as GenerateTestsInput);