derive: reword in_doc error message if code block is absent

rinja-rs · Nov 21, 2024 · b291e1a · b291e1a
1 parent 8369243
commit b291e1a
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/rinja_derive/src/input.rs b/rinja_derive/src/input.rs
@@ -441,7 +441,8 @@ fn no_rinja_code_block(span: Span, ast: &syn::DeriveInput) -> CompileError {
     };
     CompileError::no_file_info(
         format!(
-            "when using `in_doc = true`, the {kind}'s documentation needs a `rinja` code block"
+            "when using `in_doc` with the value `true`, the {kind}'s documentation needs a \
+             `rinja` code block"
         ),
         Some(span),
     )

diff --git a/rinja_derive/src/tests.rs b/rinja_derive/src/tests.rs
@@ -747,7 +747,8 @@ fn test_code_in_comment() {
     let err = build_template(&ast).unwrap_err();
     assert_eq!(
         err.to_string(),
-        "when using `in_doc = true`, the struct's documentation needs a `rinja` code block"
+        "when using `in_doc` with the value `true`, the struct's documentation needs a `rinja` \
+         code block"
     );
 
     let ts = "

diff --git a/testing/tests/ui/rinja-block.stderr b/testing/tests/ui/rinja-block.stderr
@@ -6,7 +6,7 @@ error: unknown node `fail`
 5 | /// Some documentation
   | ^^^^^^^^^^^^^^^^^^^^^^
 
-error: when using `in_doc = true`, the struct's documentation needs a `rinja` code block
+error: when using `in_doc` with the value `true`, the struct's documentation needs a `rinja` code block
   --> tests/ui/rinja-block.rs:15:34
    |
 15 | #[template(ext = "txt", in_doc = true)]
@@ -36,7 +36,7 @@ error: template attribute `in_doc` expects a boolean value
 51 | #[template(ext = "txt", in_doc = "yes")]
    |                                  ^^^^^
 
-error: when using `in_doc = true`, the enum's documentation needs a `rinja` code block
+error: when using `in_doc` with the value `true`, the enum's documentation needs a `rinja` code block
   --> tests/ui/rinja-block.rs:60:34
    |
 60 | #[template(ext = "txt", in_doc = true)]