Skip to content

Commit

Permalink
docs: fix up previous docs change a bit (#362)
Browse files Browse the repository at this point in the history
  • Loading branch information
TrapinchO authored Apr 3, 2024
1 parent 7b42b12 commit 97766e8
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 31 deletions.
45 changes: 24 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,18 @@ 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:
\
diagnostic error code: oops::my::bad (link)
Error: oops!
\
Begin snippet for bad_file.rs starting
at line 2, column 3
\
snippet line 1: source
Error: Received some bad JSON from the source. Unable to parse.
Caused by: missing field `foo` at line 1 column 1700
\
snippet line 2: text
highlight starting at line 1, column 3: This bit here
Begin snippet for https://api.nuget.org/v3/registration5-gz-semver2/json.net/index.json starting
at line 1, column 1659
\
snippet line 3: here
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
highlight starting at line 1, column 1699: last parsing location
\
diagnostic help: try doing it better next time?
diagnostic help: This is a bug. It might be in ruget, or it might be in the
source you're using, but it's definitely a bug and should be reported.
diagnostic error code: ruget::api::bad_json
" />

> **NOTE: You must enable the `"fancy"` crate feature to get fancy report
Expand Down Expand Up @@ -164,17 +162,22 @@ And this is the output you'll get if you run this program:
<img src="https://raw.githubusercontent.com/zkat/miette/main/images/single-line-example.png" alt="
Narratable printout:
\
Error: Types mismatched for operation.
Diagnostic severity: error
Begin snippet starting at line 1, column 1
diagnostic error code: oops::my::bad (link)
Error: oops!

\
Begin snippet for bad_file.rs starting
at line 2, column 3
\
snippet line 1: source

\
snippet line 2: text
highlight starting at line 1, column 3: This bit here
\
snippet line 3: here
\
snippet line 1: 3 + &quot;5&quot;
label starting at line 1, column 1: int
label starting at line 1, column 1: doesn't support these values.
label starting at line 1, column 1: string
diagnostic help: Change int or string to be the right types and try again.
diagnostic code: nu::parser::unsupported_operation
For more details, see https://docs.rs/nu-parser/0.1.0/nu-parser/enum.ParseError.html#variant.UnsupportedOperation">
diagnostic help: try doing it better next time?">

### Using

Expand Down
25 changes: 15 additions & 10 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -161,17 +161,22 @@
//! <img src="https://raw.githubusercontent.com/zkat/miette/main/images/single-line-example.png" alt="
//! Narratable printout:
//! \
//! Error: Types mismatched for operation.
//! Diagnostic severity: error
//! Begin snippet starting at line 1, column 1
//! diagnostic error code: oops::my::bad (link)
//! Error: oops!
//!
//! \
//! Begin snippet for bad_file.rs starting
//! at line 2, column 3
//! \
//! snippet line 1: source
//!
//! \
//! snippet line 2: text
//! highlight starting at line 1, column 3: This bit here
//! \
//! snippet line 3: here
//! \
//! snippet line 1: 3 + &quot;5&quot;
//! label starting at line 1, column 1: int
//! label starting at line 1, column 1: doesn't support these values.
//! label starting at line 1, column 1: string
//! diagnostic help: Change int or string to be the right types and try again.
//! diagnostic code: nu::parser::unsupported_operation
//! For more details, see https://docs.rs/nu-parser/0.1.0/nu-parser/enum.ParseError.html#variant.UnsupportedOperation">
//! diagnostic help: try doing it better next time?">
//!
//! ## Using
//!
Expand Down

0 comments on commit 97766e8

Please sign in to comment.