docs(traits): add docs to each of the trait mods

closes #2
onkoe · Jul 10, 2024 · 179e59d · 179e59d
1 parent 329031d
commit 179e59d
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/macros/src/traits/display.rs b/macros/src/traits/display.rs
@@ -1,3 +1,7 @@
+//! # Display
+//!
+//! Implements `Display` for the user's error type.
+
 use proc_macro2::{Span as Span2, TokenStream as TokenStream2};
 use quote::quote;
 use syn::{punctuated::Punctuated, token::Comma, Ident, Meta, Variant};

diff --git a/macros/src/traits/error.rs b/macros/src/traits/error.rs
@@ -1,3 +1,7 @@
+//! # Error
+//!
+//! Implements the `Error` trait for the user's error type.
+
 use proc_macro2::TokenStream as TokenStream2;
 use quote::quote;
 use syn::{punctuated::Punctuated, token::Comma, Ident, Variant};
@@ -31,7 +35,7 @@ pub fn source(
     enum_name: &Ident,
 ) -> syn::Result<TokenStream2> {
     // store each variant's match arm, if it's even there!
-    let list = variants.iter().map(|v| {
+    let match_arms = variants.iter().map(|v| {
         let is_from = variant_froms.contains(&v);
 
         match is_from {
@@ -70,7 +74,7 @@ pub fn source(
     Ok(quote! {
         fn source(&self) -> Option<&(dyn Error + 'static)> {
             match *self {
-                #(#list),*
+                #(#match_arms),*
             }
         }
     })

diff --git a/macros/src/traits/from.rs b/macros/src/traits/from.rs
@@ -1,6 +1,6 @@
 //! # From
 //!
-//! Implements the `From` trait for the user's type.
+//! Implements the `From` trait for the user's error type.
 
 use proc_macro2::{Span as Span2, TokenStream as TokenStream2};
 use quote::{quote, quote_spanned};