Skip to content

Commit 7b42b12

Browse files
authored
fix(docs): updated example image (fixes #111) (#270)
1 parent 3eabbce commit 7b42b12

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,20 @@ can print out like this (or in any format you like!):
1313

1414
<img src="https://raw.githubusercontent.com/zkat/miette/main/images/serde_json.png" alt="Hi! miette also includes a screen-reader-oriented diagnostic printer that's enabled in various situations, such as when you use NO_COLOR or CLICOLOR settings, or on CI. This behavior is also fully configurable and customizable. For example, this is what this particular diagnostic will look like when the narrated printer is enabled:
1515
\
16-
Error: Received some bad JSON from the source. Unable to parse.
17-
Caused by: missing field `foo` at line 1 column 1700
16+
diagnostic error code: oops::my::bad (link)
17+
Error: oops!
1818
\
19-
Begin snippet for https://api.nuget.org/v3/registration5-gz-semver2/json.net/index.json starting
20-
at line 1, column 1659
19+
Begin snippet for bad_file.rs starting
20+
at line 2, column 3
2121
\
22-
snippet line 1: gs&quot;:[&quot;json&quot;],&quot;title&quot;:&quot;&quot;,&quot;version&quot;:&quot;1.0.0&quot;},&quot;packageContent&quot;:&quot;https://api.nuget.o
23-
highlight starting at line 1, column 1699: last parsing location
22+
snippet line 1: source
2423
\
25-
diagnostic help: This is a bug. It might be in ruget, or it might be in the
26-
source you're using, but it's definitely a bug and should be reported.
27-
diagnostic error code: ruget::api::bad_json
24+
snippet line 2: text
25+
highlight starting at line 1, column 3: This bit here
26+
\
27+
snippet line 3: here
28+
\
29+
diagnostic help: try doing it better next time?
2830
" />
2931

3032
> **NOTE: You must enable the `"fancy"` crate feature to get fancy report

images/single-line-example.png

-237 KB
Loading

0 commit comments

Comments
 (0)