docs

Author: hkratz

Cargo.toml

@@ -3,7 +3,7 @@ name = "flexpect"
 version = "0.1.0"
 edition = "2018"
 license = "MIT OR Apache-2.0"
-description = "`#[flexpect::e(...)]` compiles to `#[expect(...)]` for newer versions of Rust and to `#[allow(...)]` when not supported."
+description = "#[flexpect::e(...)] compiles to #[expect(...)] for newer versions of Rust and to #[allow(...)] when not supported."
 readme = "README.md"
 repository = "https://github.com/rusticstuff/flexpect"
 homepage = "https://github.com/rusticstuff/flexpect"

README.md

@@ -17,7 +17,8 @@ flexpect = "0.1.0"
 Then use the `#[flexpect::e(...)]` or `#[flexpect::flexpect(...)]` attributes instead of `#[expect(...)]`:
 
 ```rust
-#[flexpect::e(unused_variables)] // instead of #[expect(unused_variables)]
+// instead of #[expect(unused_variables)]
+#[flexpect::e(unused_variables)]
 fn example() {
     let x = 1;
 }
@@ -26,7 +27,8 @@ fn example() {
 ```rust
 use flexpect::flexpect;
 
-#[flexpect(clippy::clone_on_copy)]  // instead of #[expect(clippy::clone_on_copy)]
+// instead of #[expect(clippy::clone_on_copy)]
+#[flexpect(clippy::clone_on_copy)]
 fn clippy_example() {
     let _ = 32.clone();
 }

src/lib.rs

@@ -48,38 +48,106 @@ extern crate proc_macro;
 
 use proc_macro::TokenStream;
 
+/// `#[flexpect::e(...)]` compiles to `#[expect(...)]` for newer versions of Rust and to `#[allow(...)]` when not supported.
+///
+/// # Example
+///
+/// ```
+/// #[flexpect::e(clippy::clone_on_copy)]
+/// fn clippy_example() {
+///     let _ = 32.clone();
+/// }
+/// ```
 #[rustversion::any(before(1.43.0))]
 #[proc_macro_attribute]
 pub fn e(_attr_args: TokenStream, item: TokenStream) -> TokenStream {
     // using #[allow(...)] does not work before 1.43.0 due to a bug
     item
 }
 
+/// `#[flexpect::e(...)]` compiles to `#[expect(...)]` for newer versions of Rust and to `#[allow(...)]` when not supported.
+///
+/// # Example
+///
+/// ```
+/// #[flexpect::e(clippy::clone_on_copy)]
+/// fn clippy_example() {
+///     let _ = 32.clone();
+/// }
+/// ```
 #[rustversion::all(since(1.43.0), before(1.81))]
 #[proc_macro_attribute]
 pub fn e(attr_args: TokenStream, item: TokenStream) -> TokenStream {
     create_attr("allow", attr_args, item)
 }
 
+/// `#[flexpect::e(...)]` compiles to `#[expect(...)]` for newer versions of Rust and to `#[allow(...)]` when not supported.
+///
+/// # Example
+///
+/// ```
+/// #[flexpect::e(clippy::clone_on_copy)]
+/// fn clippy_example() {
+///     let _ = 32.clone();
+/// }
+/// ```
 #[rustversion::since(1.81)]
 #[proc_macro_attribute]
 pub fn e(attr_args: TokenStream, item: TokenStream) -> TokenStream {
     create_attr("expect", attr_args, item)
 }
 
+/// `#[flexpect(...)]` compiles to `#[expect(...)]` for newer versions of Rust and to `#[allow(...)]` when not supported.
+///
+/// # Example
+///
+/// ```
+/// use flexpect::flexpect;
+///
+/// #[flexpect(clippy::clone_on_copy)]  // instead of #[expect(clippy::clone_on_copy)]
+/// fn clippy_example() {
+///     let _ = 32.clone();
+/// }
+/// ```
 #[rustversion::any(before(1.43.0))]
 #[proc_macro_attribute]
 pub fn flexpect(_attr_args: TokenStream, item: TokenStream) -> TokenStream {
     // using #[allow(...)] does not work before 1.43.0 due to a bug
     item
 }
 
+/// `#[flexpect(...)]` compiles to `#[expect(...)]` for newer versions of Rust and to `#[allow(...)]` when not supported.
+///
+/// # Example
+///
+/// ```
+/// use flexpect::flexpect;
+///
+/// // instead of #[expect(clippy::clone_on_copy)]
+/// #[flexpect(clippy::clone_on_copy)]
+/// fn clippy_example() {
+///     let _ = 32.clone();
+/// }
+/// ```
 #[rustversion::all(since(1.43.0), before(1.81))]
 #[proc_macro_attribute]
 pub fn flexpect(attr_args: TokenStream, item: TokenStream) -> TokenStream {
     create_attr("allow", attr_args, item)
 }
 
+/// `#[flexpect(...)]` compiles to `#[expect(...)]` for newer versions of Rust and to `#[allow(...)]` when not supported.
+///
+/// # Example
+///
+/// ```
+/// use flexpect::flexpect;
+///
+/// // instead of #[expect(clippy::clone_on_copy)]
+/// #[flexpect(clippy::clone_on_copy)]
+/// fn clippy_example() {
+///     let _ = 32.clone();
+/// }
+/// ```
 #[rustversion::since(1.81)]
 #[proc_macro_attribute]
 pub fn flexpect(attr_args: TokenStream, item: TokenStream) -> TokenStream {