Fix inconsistent naming

Aleph-Alpha · May 30, 2022 · 654c98b · 654c98b
1 parent 19665a1
commit 654c98b
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/macros/src/types/enum.rs b/macros/src/types/enum.rs
@@ -99,7 +99,7 @@ fn format_variant(
     let variant_dependencies = variant_type.dependencies;
     let inline_type = variant_type.inline;
 
-    let doc = match doc_string {
+    let doc_string = match doc_string {
         Some(s) => format!("\n/**\n* {}\n*/\n", s),
         None => "".to_string(),
     };
@@ -108,21 +108,21 @@ fn format_variant(
         Tagged::Untagged => quote!(#inline_type),
         Tagged::Externally => match &variant.fields {
             Fields::Unit => quote!(format!("\"{}\"", #name)),
-            _ => quote!(format!("{}{{ {}: {} }}", #doc, #name, #inline_type)),
+            _ => quote!(format!("{}{{ {}: {} }}", #doc_string, #name, #inline_type)),
         },
         Tagged::Adjacently { tag, content } => match &variant.fields {
             Fields::Unnamed(unnamed) if unnamed.unnamed.len() == 1 => {
                 let ty = format_type(&unnamed.unnamed[0].ty, dependencies, generics);
-                quote!(format!("{}{{ {}: \"{}\", {}: {} }}", #doc, #tag, #name, #content, #ty))
+                quote!(format!("{}{{ {}: \"{}\", {}: {} }}", #doc_string, #tag, #name, #content, #ty))
             }
-            Fields::Unit => quote!(format!("{}{{ {}: \"{}\" }}", #doc, #tag, #name)),
-            _ => quote!(format!("{}{{ {}: \"{}\", {}: {} }}", #doc, #tag, #name, #content, #inline_type)),
+            Fields::Unit => quote!(format!("{}{{ {}: \"{}\" }}", #doc_string, #tag, #name)),
+            _ => quote!(format!("{}{{ {}: \"{}\", {}: {} }}", #doc_string, #tag, #name, #content, #inline_type)),
         },
         Tagged::Internally { tag } => match variant_type.inline_flattened {
             Some(inline_flattened) => quote! {
                 format!(
                     "{}{{ {}: \"{}\", {} }}",
-                    #doc,
+                    #doc_string,
                     #tag,
                     #name,
                     #inline_flattened
@@ -131,11 +131,11 @@ fn format_variant(
             None => match &variant.fields {
                 Fields::Unnamed(unnamed) if unnamed.unnamed.len() == 1 => {
                     let ty = format_type(&unnamed.unnamed[0].ty, dependencies, generics);
-                    quote!(format!("{}{{ {}: \"{}\" }} & {}", #doc, #tag, #name, #ty))
+                    quote!(format!("{}{{ {}: \"{}\" }} & {}", #doc_string, #tag, #name, #ty))
                 }
-                Fields::Unit => quote!(format!("{}{{ {}: \"{}\" }}", #doc, #tag, #name)),
+                Fields::Unit => quote!(format!("{}{{ {}: \"{}\" }}", #doc_string, #tag, #name)),
                 _ => {
-                    quote!(format!("{}{{ {}: \"{}\" }} & {}", #doc, #tag, #name, #inline_type))
+                    quote!(format!("{}{{ {}: \"{}\" }} & {}", #doc_string, #tag, #name, #inline_type))
                 }
             },
         },

diff --git a/macros/src/types/newtype.rs b/macros/src/types/newtype.rs
@@ -52,14 +52,14 @@ pub(crate) fn newtype(
         None => format_type(inner_ty, &mut dependencies, generics),
     };
 
-    let doc = match doc_string {
+    let doc_string = match doc_string {
         Some(s) => format!("\n/**\n* {}\n*/\n", s),
         None => "".to_string(),
     };
 
     let generic_args = format_generics(&mut dependencies, generics);
     Ok(DerivedTS {
-        decl: quote!(format!("{}type {}{} = {};", #doc, #name, #generic_args, #inline_def)),
+        decl: quote!(format!("{}type {}{} = {};", #doc_string, #name, #generic_args, #inline_def)),
         inline: inline_def,
         inline_flattened: None,
         name: name.to_owned(),

diff --git a/ts-rs/src/lib.rs b/ts-rs/src/lib.rs
@@ -201,7 +201,7 @@ mod export;
 ///   Flatten this field (only works if the field is a struct)  
 ///   
 /// - `#[ts(doc_string = "..")]`:  
-///   Adding typescript docstring to this field
+///   Add typescript docstring to this field
 ///
 /// ### enum attributes
 ///