docs: Round out the documentation

examples/custom_error.rs

@@ -15,7 +15,7 @@ fn main() {
 pub static C: u32 = 0 - 1;
 //~^ ERROR could not evaluate static initializer
 "#;
-    let message = &[Group::with_title(
+    let report = &[Group::with_title(
         Level::ERROR
             .with_name(Some("error: internal compiler error"))
             .primary_title("could not evaluate static initializer")
@@ -30,5 +30,5 @@ pub static C: u32 = 0 - 1;
     )];
 
     let renderer = Renderer::styled().decor_style(DecorStyle::Unicode);
-    anstream::println!("{}", renderer.render(message));
+    anstream::println!("{}", renderer.render(report));
 }

examples/custom_level.rs

@@ -29,7 +29,7 @@ fn main() {
     }
 }
 "#;
-    let message = &[
+    let report = &[
         Group::with_title(
             Level::ERROR
                 .primary_title("`break` with value from a `while` loop")
@@ -64,5 +64,5 @@ fn main() {
     ];
 
     let renderer = Renderer::styled().decor_style(DecorStyle::Unicode);
-    anstream::println!("{}", renderer.render(message));
+    anstream::println!("{}", renderer.render(report));
 }

examples/elide_header.rs

@@ -8,7 +8,7 @@ def foobar(door, bar={}):
     """
 "#;
 
-    let message = &[Group::with_level(Level::NOTE)
+    let report = &[Group::with_level(Level::NOTE)
         .element(
             Snippet::source(source)
                 .fold(false)
@@ -17,5 +17,5 @@ def foobar(door, bar={}):
         .element(Level::HELP.message("Replace with `None`; initialize within function"))];
 
     let renderer = Renderer::styled();
-    anstream::println!("{}", renderer.render(message));
+    anstream::println!("{}", renderer.render(report));
 }

examples/expected_type.rs

@@ -5,7 +5,7 @@ fn main() {
                 label: "expected struct `annotate_snippets::snippet::Slice`, found reference"
                     ,
                 range: <22, 25>,"#;
-    let message =
+    let report =
         &[
             Group::with_title(Level::ERROR.primary_title("expected type, found `22`")).element(
                 Snippet::source(source)
@@ -23,5 +23,5 @@ fn main() {
         ];
 
     let renderer = Renderer::styled();
-    anstream::println!("{}", renderer.render(message));
+    anstream::println!("{}", renderer.render(report));
 }

examples/footer.rs

@@ -1,7 +1,7 @@
 use annotate_snippets::{AnnotationKind, Group, Level, Renderer, Snippet};
 
 fn main() {
-    let message =
+    let report =
         &[
             Group::with_title(Level::ERROR.primary_title("mismatched types").id("E0308")).element(
                 Snippet::source("        slices: vec![\"A\",")
@@ -17,5 +17,5 @@ fn main() {
         ];
 
     let renderer = Renderer::styled();
-    anstream::println!("{}", renderer.render(message));
+    anstream::println!("{}", renderer.render(report));
 }

examples/format.rs

@@ -23,7 +23,7 @@ fn main() {
             _ => continue,
         }
     }"#;
-    let message = &[
+    let report = &[
         Group::with_title(Level::ERROR.primary_title("mismatched types").id("E0308")).element(
             Snippet::source(source)
                 .line_start(51)
@@ -43,5 +43,5 @@ fn main() {
     ];
 
     let renderer = Renderer::styled();
-    anstream::println!("{}", renderer.render(message));
+    anstream::println!("{}", renderer.render(report));
 }

examples/highlight_message.rs

@@ -33,7 +33,7 @@ fn main() {
       found fn item `fn(Box<{MAGENTA}(dyn Any + Send + 'static){MAGENTA:#}>) -> Pin<_> {MAGENTA}{{wrapped_fn}}{MAGENTA:#}`",
     );
 
-    let message = &[
+    let report = &[
         Group::with_title(Level::ERROR.primary_title("mismatched types").id("E0308"))
             .element(
                 Snippet::source(source)
@@ -59,5 +59,5 @@ fn main() {
     ];
 
     let renderer = Renderer::styled().anonymized_line_numbers(true);
-    anstream::println!("{}", renderer.render(message));
+    anstream::println!("{}", renderer.render(report));
 }

examples/highlight_source.rs

@@ -9,7 +9,7 @@ const CON: Vec<i32> = vec![1, 2, 3]; //~ ERROR E0010
 //~| ERROR cannot call non-const method
 fn main() {}
 "#;
-    let message = &[Group::with_title(Level::ERROR.primary_title("allocations are not allowed in constants")
+    let report = &[Group::with_title(Level::ERROR.primary_title("allocations are not allowed in constants")
         .id("E0010"))
         .element(
             Snippet::source(source)
@@ -27,5 +27,5 @@ fn main() {}
     )];
 
     let renderer = Renderer::styled().anonymized_line_numbers(true);
-    anstream::println!("{}", renderer.render(message));
+    anstream::println!("{}", renderer.render(report));
 }

examples/id_hyperlink.rs

@@ -7,7 +7,7 @@ fn main() {
     let () = 4; //~ ERROR
 }
 "#;
-    let message = &[Group::with_title(
+    let report = &[Group::with_title(
         Level::ERROR
             .primary_title("mismatched types")
             .id("E0308")
@@ -30,5 +30,5 @@ fn main() {
     )];
 
     let renderer = Renderer::styled().decor_style(DecorStyle::Unicode);
-    anstream::println!("{}", renderer.render(message));
+    anstream::println!("{}", renderer.render(report));
 }

examples/multi_suggestion.rs

@@ -0,0 +1,74 @@
+use annotate_snippets::{
+    renderer::DecorStyle, AnnotationKind, Group, Level, Patch, Renderer, Snippet,
+};
+
+fn main() {
+    let source = r#"
+#![allow(dead_code)]
+struct U <T> {
+    wtf: Option<Box<U<T>>>,
+    x: T,
+}
+fn main() {
+    U {
+        wtf: Some(Box(U {
+            wtf: None,
+            x: (),
+        })),
+        x: ()
+    };
+    let _ = std::collections::HashMap(); 
+    let _ = std::collections::HashMap {};
+    let _ = Box {};
+}
+"#;
+
+    let report = &[
+        Group::with_title(Level::ERROR.primary_title(
+            "cannot construct `Box<_, _>` with struct literal syntax due to private fields",
+        ))
+        .element(
+            Snippet::source(source)
+                .path("$DIR/multi-suggestion.rs")
+                .annotation(AnnotationKind::Primary.span(295..298)),
+        )
+        .element(Level::NOTE.message("private fields `0` and `1` that were not provided")),
+        Group::with_title(Level::HELP.secondary_title(
+            "you might have meant to use an associated function to build this type",
+        ))
+        .element(
+            Snippet::source(source)
+                .path("$DIR/multi-suggestion.rs")
+                .patch(Patch::new(298..301, "::new(_)")),
+        )
+        .element(
+            Snippet::source(source)
+                .path("$DIR/multi-suggestion.rs")
+                .patch(Patch::new(298..301, "::new_uninit()")),
+        )
+        .element(
+            Snippet::source(source)
+                .path("$DIR/multi-suggestion.rs")
+                .patch(Patch::new(298..301, "::new_zeroed()")),
+        )
+        .element(
+            Snippet::source(source)
+                .path("$DIR/multi-suggestion.rs")
+                .patch(Patch::new(298..301, "::new_in(_, _)")),
+        )
+        .element(Level::NOTE.no_name().message("and 12 other candidates")),
+        Group::with_title(Level::HELP.secondary_title("consider using the `Default` trait"))
+            .element(
+                Snippet::source(source)
+                    .path("$DIR/multi-suggestion.rs")
+                    .patch(Patch::new(295..295, "<"))
+                    .patch(Patch::new(
+                        298..301,
+                        " as std::default::Default>::default()",
+                    )),
+            ),
+    ];
+
+    let renderer = Renderer::styled().decor_style(DecorStyle::Unicode);
+    anstream::println!("{}", renderer.render(report));
+}

examples/multislice.rs

@@ -1,7 +1,7 @@
 use annotate_snippets::{Annotation, Group, Level, Renderer, Snippet};
 
 fn main() {
-    let message = &[
+    let report = &[
         Group::with_title(Level::ERROR.primary_title("mismatched types"))
             .element(
                 Snippet::<Annotation<'_>>::source("Foo")
@@ -18,5 +18,5 @@ fn main() {
     ];
 
     let renderer = Renderer::styled();
-    anstream::println!("{}", renderer.render(message));
+    anstream::println!("{}", renderer.render(report));
 }

examples/struct_name_as_context.rs

@@ -9,7 +9,7 @@ fn main() {
     field6: usize,
 }
 "#;
-    let message = &[Group::with_title(
+    let report = &[Group::with_title(
         Level::ERROR.primary_title("functions are not allowed in struct definitions"),
     )
     .element(
@@ -23,5 +23,5 @@ fn main() {
     )];
 
     let renderer = Renderer::styled();
-    anstream::println!("{}", renderer.render(message));
+    anstream::println!("{}", renderer.render(report));
 }