Add doc comments for Unwrap, IsVariant (#179)

Prevents a linting issue from `missing_docs` on the derived functions Solves #159 Co-authored-by: Jelte Fennema <[email protected]>
JelteF · Feb 8, 2022 · 9e8582b · 9e8582b
1 parent 8e16178
commit 9e8582b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/is_variant.rs b/src/is_variant.rs
@@ -41,7 +41,11 @@ pub fn expand(input: &DeriveInput, trait_name: &'static str) -> Result<TokenStre
             Fields::Unnamed(_) => quote! { (..) },
             Fields::Unit => quote! {},
         };
+        let variant_name = stringify!(variant_ident);
         let func = quote! {
+            #[doc = "Returns `true` if this value is of type `"]
+            #[doc = #variant_name]
+            #[doc = "`. Returns `false` otherwise"]
             pub fn #fn_name(&self) -> bool {
                 match self {
                     #enum_name ::#variant_ident #data_pattern => true,

diff --git a/src/unwrap.rs b/src/unwrap.rs
@@ -79,8 +79,12 @@ pub fn expand(input: &DeriveInput, trait_name: &'static str) -> Result<TokenStre
         } else {
             quote! {}
         };
+        let variant_name = stringify!(variant_ident);
         let func = quote! {
             #track_caller
+            #[doc = "Unwraps this value to the `"]
+            #[doc = #variant_name]
+            #[doc = "` variant\n\nPanics if this value is of any other type"]
             pub fn #fn_name(self) -> #ret_type {
                 match self {
                     #enum_name ::#variant_ident #data_pattern => #ret_value,