berkus
/
miette
mirror of https://github.com/zkat/miette.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix(docs): updated example image (fixes #111) (#270)

This commit is contained in:
TrapinchO 2024-04-03 22:31:03 +02:00 committed by GitHub
parent 3eabbcebf1
commit 7b42b12c5f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -13,18 +13,20 @@ can print out like this (or in any format you like!):
<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: <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:
\ \
Error: Received some bad JSON from the source. Unable to parse. diagnostic error code: oops::my::bad (link)
Caused by: missing field `foo` at line 1 column 1700 Error: oops!
\ \
Begin snippet for https://api.nuget.org/v3/registration5-gz-semver2/json.net/index.json starting Begin snippet for bad_file.rs starting
at line 1, column 1659 at line 2, column 3
\ \
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 snippet line 1: source
highlight starting at line 1, column 1699: last parsing location
\ \
diagnostic help: This is a bug. It might be in ruget, or it might be in the snippet line 2: text
source you're using, but it's definitely a bug and should be reported. highlight starting at line 1, column 3: This bit here
diagnostic error code: ruget::api::bad_json \
snippet line 3: here
\
diagnostic help: try doing it better next time?
" /> " />
> **NOTE: You must enable the `"fancy"` crate feature to get fancy report > **NOTE: You must enable the `"fancy"` crate feature to get fancy report

BIN
images/single-line-example.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 292 KiB

After

Width:  |  Height:  |  Size: 54 KiB