Skip to content

Commit 334eaa9

Browse files
epageepage
authored
Merge pull request #279 from epage/improve-docs
docs: Round out the documentation
2 parents 285b7ce + d95a5ad commit 334eaa9

18 files changed

+501
-196
lines changed

‎examples/custom_error.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ fn main() {
1515
pub static C: u32 = 0 - 1;
1616
//~^ ERROR could not evaluate static initializer
1717
"#;
18-
let message = &[Group::with_title(
18+
let report = &[Group::with_title(
1919
Level::ERROR
2020
.with_name(Some("error: internal compiler error"))
2121
.primary_title("could not evaluate static initializer")
@@ -30,5 +30,5 @@ pub static C: u32 = 0 - 1;
3030
)];
3131

3232
let renderer = Renderer::styled().decor_style(DecorStyle::Unicode);
33-
anstream::println!("{}", renderer.render(message));
33+
anstream::println!("{}", renderer.render(report));
3434
}

‎examples/custom_level.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ fn main() {
2929
}
3030
}
3131
"#;
32-
let message = &[
32+
let report = &[
3333
Group::with_title(
3434
Level::ERROR
3535
.primary_title("`break` with value from a `while` loop")
@@ -64,5 +64,5 @@ fn main() {
6464
];
6565

6666
let renderer = Renderer::styled().decor_style(DecorStyle::Unicode);
67-
anstream::println!("{}", renderer.render(message));
67+
anstream::println!("{}", renderer.render(report));
6868
}

‎examples/elide_header.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ def foobar(door, bar={}):
88
"""
99
"#;
1010

11-
let message = &[Group::with_level(Level::NOTE)
11+
let report = &[Group::with_level(Level::NOTE)
1212
.element(
1313
Snippet::source(source)
1414
.fold(false)
@@ -17,5 +17,5 @@ def foobar(door, bar={}):
1717
.element(Level::HELP.message("Replace with `None`; initialize within function"))];
1818

1919
let renderer = Renderer::styled();
20-
anstream::println!("{}", renderer.render(message));
20+
anstream::println!("{}", renderer.render(report));
2121
}

‎examples/expected_type.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ fn main() {
55
label: "expected struct `annotate_snippets::snippet::Slice`, found reference"
66
,
77
range: <22, 25>,"#;
8-
let message =
8+
let report =
99
&[
1010
Group::with_title(Level::ERROR.primary_title("expected type, found `22`")).element(
1111
Snippet::source(source)
@@ -23,5 +23,5 @@ fn main() {
2323
];
2424

2525
let renderer = Renderer::styled();
26-
anstream::println!("{}", renderer.render(message));
26+
anstream::println!("{}", renderer.render(report));
2727
}

‎examples/footer.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use annotate_snippets::{AnnotationKind, Group, Level, Renderer, Snippet};
22

33
fn main() {
4-
let message =
4+
let report =
55
&[
66
Group::with_title(Level::ERROR.primary_title("mismatched types").id("E0308")).element(
77
Snippet::source(" slices: vec![\"A\",")
@@ -17,5 +17,5 @@ fn main() {
1717
];
1818

1919
let renderer = Renderer::styled();
20-
anstream::println!("{}", renderer.render(message));
20+
anstream::println!("{}", renderer.render(report));
2121
}

‎examples/format.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ fn main() {
2323
_ => continue,
2424
}
2525
}"#;
26-
let message = &[
26+
let report = &[
2727
Group::with_title(Level::ERROR.primary_title("mismatched types").id("E0308")).element(
2828
Snippet::source(source)
2929
.line_start(51)
@@ -43,5 +43,5 @@ fn main() {
4343
];
4444

4545
let renderer = Renderer::styled();
46-
anstream::println!("{}", renderer.render(message));
46+
anstream::println!("{}", renderer.render(report));
4747
}

‎examples/highlight_message.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ fn main() {
3333
found fn item `fn(Box<{MAGENTA}(dyn Any + Send + 'static){MAGENTA:#}>) -> Pin<_> {MAGENTA}{{wrapped_fn}}{MAGENTA:#}`",
3434
);
3535

36-
let message = &[
36+
let report = &[
3737
Group::with_title(Level::ERROR.primary_title("mismatched types").id("E0308"))
3838
.element(
3939
Snippet::source(source)
@@ -59,5 +59,5 @@ fn main() {
5959
];
6060

6161
let renderer = Renderer::styled().anonymized_line_numbers(true);
62-
anstream::println!("{}", renderer.render(message));
62+
anstream::println!("{}", renderer.render(report));
6363
}

‎examples/highlight_source.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const CON: Vec<i32> = vec![1, 2, 3]; //~ ERROR E0010
99
//~| ERROR cannot call non-const method
1010
fn main() {}
1111
"#;
12-
let message = &[Group::with_title(Level::ERROR.primary_title("allocations are not allowed in constants")
12+
let report = &[Group::with_title(Level::ERROR.primary_title("allocations are not allowed in constants")
1313
.id("E0010"))
1414
.element(
1515
Snippet::source(source)
@@ -27,5 +27,5 @@ fn main() {}
2727
)];
2828

2929
let renderer = Renderer::styled().anonymized_line_numbers(true);
30-
anstream::println!("{}", renderer.render(message));
30+
anstream::println!("{}", renderer.render(report));
3131
}

‎examples/id_hyperlink.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ fn main() {
77
let () = 4; //~ ERROR
88
}
99
"#;
10-
let message = &[Group::with_title(
10+
let report = &[Group::with_title(
1111
Level::ERROR
1212
.primary_title("mismatched types")
1313
.id("E0308")
@@ -30,5 +30,5 @@ fn main() {
3030
)];
3131

3232
let renderer = Renderer::styled().decor_style(DecorStyle::Unicode);
33-
anstream::println!("{}", renderer.render(message));
33+
anstream::println!("{}", renderer.render(report));
3434
}

‎examples/multi_suggestion.rs

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
use annotate_snippets::{
2+
renderer::DecorStyle, AnnotationKind, Group, Level, Patch, Renderer, Snippet,
3+
};
4+
5+
fn main() {
6+
let source = r#"
7+
#![allow(dead_code)]
8+
struct U <T> {
9+
wtf: Option<Box<U<T>>>,
10+
x: T,
11+
}
12+
fn main() {
13+
U {
14+
wtf: Some(Box(U {
15+
wtf: None,
16+
x: (),
17+
})),
18+
x: ()
19+
};
20+
let _ = std::collections::HashMap();
21+
let _ = std::collections::HashMap {};
22+
let _ = Box {};
23+
}
24+
"#;
25+
26+
let report = &[
27+
Group::with_title(Level::ERROR.primary_title(
28+
"cannot construct `Box<_, _>` with struct literal syntax due to private fields",
29+
))
30+
.element(
31+
Snippet::source(source)
32+
.path("$DIR/multi-suggestion.rs")
33+
.annotation(AnnotationKind::Primary.span(295..298)),
34+
)
35+
.element(Level::NOTE.message("private fields `0` and `1` that were not provided")),
36+
Group::with_title(Level::HELP.secondary_title(
37+
"you might have meant to use an associated function to build this type",
38+
))
39+
.element(
40+
Snippet::source(source)
41+
.path("$DIR/multi-suggestion.rs")
42+
.patch(Patch::new(298..301, "::new(_)")),
43+
)
44+
.element(
45+
Snippet::source(source)
46+
.path("$DIR/multi-suggestion.rs")
47+
.patch(Patch::new(298..301, "::new_uninit()")),
48+
)
49+
.element(
50+
Snippet::source(source)
51+
.path("$DIR/multi-suggestion.rs")
52+
.patch(Patch::new(298..301, "::new_zeroed()")),
53+
)
54+
.element(
55+
Snippet::source(source)
56+
.path("$DIR/multi-suggestion.rs")
57+
.patch(Patch::new(298..301, "::new_in(_, _)")),
58+
)
59+
.element(Level::NOTE.no_name().message("and 12 other candidates")),
60+
Group::with_title(Level::HELP.secondary_title("consider using the `Default` trait"))
61+
.element(
62+
Snippet::source(source)
63+
.path("$DIR/multi-suggestion.rs")
64+
.patch(Patch::new(295..295, "<"))
65+
.patch(Patch::new(
66+
298..301,
67+
" as std::default::Default>::default()",
68+
)),
69+
),
70+
];
71+
72+
let renderer = Renderer::styled().decor_style(DecorStyle::Unicode);
73+
anstream::println!("{}", renderer.render(report));
74+
}

0 commit comments

Comments
 (0)