itsscb/eyre
1
0
Fork 0
mirror of https://github.com/eyre-rs/eyre.git synced 2025-09-27 13:01:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use <span> instead of <font> in documentation (#44)

Browse Source 
* Use `<span>` instead of `<font>` in documentation

The `<font>` tag was deprecated in [HTML 4.01]. Let's use the verbose
but standardized `<span>` tag with discouraged but supported inline
styles instead.

(I was wrong when I said it was deprecated before I was born; though
[HTML 4]'s spec was published in 1997, about 6 months before I was born,
`<font>` was only deprecated in HTML 4.01, published 2 years later when
I was about 16 months old.)

[HTML 4]: https://www.w3.org/TR/REC-html40-971218/
[HTML 4.01]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/font

* Add script to convert `<span>` to `<font>` in docs

```
$ ./scripts/fix_html_examples.py --help
usage: fix_html_examples.py [-h] file [file ...]

Convert HTML from Gnome terminal's 'Copy as HTML' feature to use modern
<span> tags and inline CSS. This script is idempotent, i.e. multiple
invocations will not change the output past the first invocation.

positional arguments:
  file        Rust file to update <pre> blocks in.

optional arguments:
  -h, --help  show this help message and exit

$ ./scripts/fix_html_examples.py src/*.rs
Nothing to fix in src/config.rs
Nothing to fix in src/handler.rs
Updated example colored output in src/lib.rs
Nothing to fix in src/private.rs
Nothing to fix in src/writers.rs

$ ./scripts/fix_html_examples.py src/*.rs
Nothing to fix in src/config.rs
Nothing to fix in src/handler.rs
Nothing to fix in src/lib.rs
Nothing to fix in src/private.rs
Nothing to fix in src/writers.rs
```

Co-authored-by: Rebecca Turner <rturner@linkedin.com>
This commit is contained in:
Rebecca Turner 2020-07-30 14:23:18 -04:00 committed by GitHub
parent 74c46d6090
commit 544ef9feba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 220 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
scripts/default.nix Normal file
View File

@ -0,0 +1,13 @@
{ pkgs ? import <nixpkgs> { } }:
let
inherit (pkgs) stdenv lib python38;
py = python38.withPackages (pypkgs: with pypkgs; [ beautifulsoup4 ]);
in stdenv.mkDerivation {
pname = "color-eyre-scripts";
version = "0.0.0";
src = ./.;
buildInputs = [ py ];
}

126
scripts/fix_html_examples.py Executable file
View File

@ -0,0 +1,126 @@
#! /usr/bin/env python3.8
from __future__ import annotations
import argparse
from argparse import FileType, ArgumentParser
import enum
import sys
from bs4 import BeautifulSoup, Tag
class LineType(enum.Enum):
OUTER_DOC = enum.auto()
INNER_DOC = enum.auto()
SOURCE = enum.auto()
@classmethod
def from_line(cls, line: str) -> (LineType, str):
if line.startswith("//!"):
return (cls.OUTER_DOC, line[len("//!") :])
elif line.startswith("///"):
return (cls.INNER_DOC, line[len("///") :])
else:
return (cls.SOURCE, line)
def prefix(self) -> str:
if self == LineType.OUTER_DOC:
return "//!"
elif self == LineType.INNER_DOC:
return "///"
else:
return ""
def fix_gnome_html(fh: file) -> str:
"""Tweaks for fixing "Copy as HTML" output from gnome-terminal
Reads source from a Rust file.
"""
anything_changed = False
line_type = LineType.SOURCE
# Lines of current HTML <pre> chunk
pre_chunk = []
# Lines of processed file
ret = []
for (line_type, stripped_line), line in map(
lambda line: (LineType.from_line(line), line), fh.readlines()
):
if line_type == LineType.SOURCE:
ret.append(line)
elif stripped_line.lstrip().startswith("<pre"):
pre_chunk = [stripped_line]
elif stripped_line.rstrip().endswith("</pre>"):
pre_chunk.append(stripped_line)
if any("<font" in line for line in pre_chunk):
joined_chunk = "".join(pre_chunk)
fixed_chunk = fix_pre(joined_chunk, prefix=line_type.prefix())
anything_changed = joined_chunk != fixed_chunk
ret.append(fixed_chunk)
pre_chunk = []
else:
prefix = line_type.prefix()
ret.extend(line_type.prefix() + line for line in pre_chunk)
elif pre_chunk:
pre_chunk.append(stripped_line)
else:
ret.append(line)
return "".join(ret) if anything_changed else None
def fix_pre(html: str, prefix: str = "") -> str:
"""Fixes an individual <pre> tag from Gnome.
Optionally prepends a given prefix to each line in the returned output.
"""
soup = BeautifulSoup(html, "html.parser")
for pre in soup.find_all("pre"):
for tag in pre.find_all("font"):
# <font color=xxx> -> <span style="color: xxx">
tag.name = "span"
color = tag.attrs.pop("color")
tag["style"] = f"color: {color}"
return "".join(prefix + line for line in str(soup).splitlines(keepends=True))
def main():
parser = ArgumentParser(
description="""Convert HTML from Gnome terminal's 'Copy as HTML' feature
to use modern <span> tags and inline CSS.
This script is idempotent, i.e. multiple invocations will not change
the output past the first invocation."""
)
parser.add_argument(
"file",
nargs="+",
type=FileType("r+", encoding="utf-8"),
help="""Rust file to update <pre> blocks in.""",
)
args = parser.parse_args()
for fh in args.file:
if not fh.name.endswith(".rs"):
print(
"This script only fixes Rust source files; you probably didn't mean to include",
fh.name,
"so I'll skip processing it.",
)
new_content = fix_gnome_html(fh)
if new_content is not None:
print("Updated example colored output in", fh.name)
fh.seek(0)
fh.write(new_content)
else:
print("Nothing to fix in", fh.name)
fh.close()
if __name__ == "__main__":
main()

162
src/lib.rs
View File

@ -5,27 +5,27 @@
//!
//! `color_eyre` helps you build error reports that look like this:
//!
//! <pre><font color="#06989A"><b>color-eyre</b></font> on <font color="#75507B"><b> hooked</b></font> <font color="#CC0000"><b>[$!] </b></font>is <font color="#FF8700"><b>📦 v0.5.0</b></font> via <font color="#CC0000"><b>🦀 v1.44.0</b></font>
//! <font color="#4E9A06"><b>❯</b></font> cargo run --example custom_section
//! <font color="#4E9A06"><b> Finished</b></font> dev [unoptimized + debuginfo] target(s) in 0.04s
//! <font color="#4E9A06"><b> Running</b></font> `target/debug/examples/custom_section`
//! <pre><span style="color: #06989A"><b>color-eyre</b></span> on <span style="color: #75507B"><b> hooked</b></span> <span style="color: #CC0000"><b>[$!] </b></span>is <span style="color: #FF8700"><b>📦 v0.5.0</b></span> via <span style="color: #CC0000"><b>🦀 v1.44.0</b></span>
//! <span style="color: #4E9A06"><b>❯</b></span> cargo run --example custom_section
//! <span style="color: #4E9A06"><b> Finished</b></span> dev [unoptimized + debuginfo] target(s) in 0.04s
//! <span style="color: #4E9A06"><b> Running</b></span> `target/debug/examples/custom_section`
//! Error:
//! 0: <font color="#F15D22">Unable to read config</font>
//! 1: <font color="#F15D22">cmd exited with non-zero status code</font>
//! 0: <span style="color: #F15D22">Unable to read config</span>
//! 1: <span style="color: #F15D22">cmd exited with non-zero status code</span>
//!
//! Stderr:
//! cat: fake_file: No such file or directory
//!
//! ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ SPANTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
//!
//! 0: <font color="#F15D22">custom_section::output2</font> with <font color="#34E2E2">self=&quot;cat&quot; &quot;fake_file&quot;</font>
//! at <font color="#75507B">examples/custom_section.rs</font>:<font color="#75507B">14</font>
//! 1: <font color="#F15D22">custom_section::read_file</font> with <font color="#34E2E2">path=&quot;fake_file&quot;</font>
//! at <font color="#75507B">examples/custom_section.rs</font>:<font color="#75507B">58</font>
//! 2: <font color="#F15D22">custom_section::read_config</font>
//! at <font color="#75507B">examples/custom_section.rs</font>:<font color="#75507B">63</font>
//! 0: <span style="color: #F15D22">custom_section::output2</span> with <span style="color: #34E2E2">self=&quot;cat&quot; &quot;fake_file&quot;</span>
//! at <span style="color: #75507B">examples/custom_section.rs</span>:<span style="color: #75507B">14</span>
//! 1: <span style="color: #F15D22">custom_section::read_file</span> with <span style="color: #34E2E2">path=&quot;fake_file&quot;</span>
//! at <span style="color: #75507B">examples/custom_section.rs</span>:<span style="color: #75507B">58</span>
//! 2: <span style="color: #F15D22">custom_section::read_config</span>
//! at <span style="color: #75507B">examples/custom_section.rs</span>:<span style="color: #75507B">63</span>
//!
//! <font color="#34E2E2">Suggestion</font>: try using a file that exists next time</pre>
//! <span style="color: #34E2E2">Suggestion</span>: try using a file that exists next time</pre>
//!
//! ## Setup
//!
@ -111,56 +111,56 @@
//! Running `cargo run --example usage` without `RUST_LIB_BACKTRACE` set will produce a minimal
//! report like this:
//!
//! <pre><font color="#06989A"><b>color-eyre</b></font> on <font color="#75507B"><b> hooked</b></font> <font color="#CC0000"><b>[$!] </b></font>is <font color="#FF8700"><b>📦 v0.5.0</b></font> via <font color="#CC0000"><b>🦀 v1.44.0</b></font> took <font color="#C4A000"><b>2s</b></font>
//! <font color="#CC0000"><b>❯</b></font> cargo run --example usage
//! <font color="#4E9A06"><b> Finished</b></font> dev [unoptimized + debuginfo] target(s) in 0.04s
//! <font color="#4E9A06"><b> Running</b></font> `target/debug/examples/usage`
//! <font color="#A1A1A1">Jul 05 19:15:58.026 </font><font color="#4E9A06"> INFO</font> <b>read_config</b>:<b>read_file{</b>path=&quot;fake_file&quot;<b>}</b>: Reading file
//! <pre><span style="color: #06989A"><b>color-eyre</b></span> on <span style="color: #75507B"><b> hooked</b></span> <span style="color: #CC0000"><b>[$!] </b></span>is <span style="color: #FF8700"><b>📦 v0.5.0</b></span> via <span style="color: #CC0000"><b>🦀 v1.44.0</b></span> took <span style="color: #C4A000"><b>2s</b></span>
//! <span style="color: #CC0000"><b>❯</b></span> cargo run --example usage
//! <span style="color: #4E9A06"><b> Finished</b></span> dev [unoptimized + debuginfo] target(s) in 0.04s
//! <span style="color: #4E9A06"><b> Running</b></span> `target/debug/examples/usage`
//! <span style="color: #A1A1A1">Jul 05 19:15:58.026 </span><span style="color: #4E9A06"> INFO</span> <b>read_config</b>:<b>read_file{</b>path=&quot;fake_file&quot;<b>}</b>: Reading file
//! Error:
//! 0: <font color="#F15D22">Unable to read config</font>
//! 1: <font color="#F15D22">No such file or directory (os error 2)</font>
//! 0: <span style="color: #F15D22">Unable to read config</span>
//! 1: <span style="color: #F15D22">No such file or directory (os error 2)</span>
//!
//! ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ SPANTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
//!
//! 0: <font color="#F15D22">usage::read_file</font> with <font color="#34E2E2">path=&quot;fake_file&quot;</font>
//! at <font color="#75507B">examples/usage.rs</font>:<font color="#75507B">32</font>
//! 1: <font color="#F15D22">usage::read_config</font>
//! at <font color="#75507B">examples/usage.rs</font>:<font color="#75507B">38</font>
//! 0: <span style="color: #F15D22">usage::read_file</span> with <span style="color: #34E2E2">path=&quot;fake_file&quot;</span>
//! at <span style="color: #75507B">examples/usage.rs</span>:<span style="color: #75507B">32</span>
//! 1: <span style="color: #F15D22">usage::read_config</span>
//! at <span style="color: #75507B">examples/usage.rs</span>:<span style="color: #75507B">38</span>
//!
//! <font color="#34E2E2">Suggestion</font>: try using a file that exists next time</pre>
//! <span style="color: #34E2E2">Suggestion</span>: try using a file that exists next time</pre>
//!
//! <br>
//!
//! Running `RUST_LIB_BACKTRACE=1 cargo run --example usage` tells `color-eyre` to use the short
//! format, which additionally capture a [`backtrace::Backtrace`]:
//!
//! <pre><font color="#06989A"><b>color-eyre</b></font> on <font color="#75507B"><b> hooked</b></font> <font color="#CC0000"><b>[$!] </b></font>is <font color="#FF8700"><b>📦 v0.5.0</b></font> via <font color="#CC0000"><b>🦀 v1.44.0</b></font>
//! <font color="#CC0000"><b>❯</b></font> RUST_LIB_BACKTRACE=1 cargo run --example usage
//! <font color="#4E9A06"><b> Finished</b></font> dev [unoptimized + debuginfo] target(s) in 0.04s
//! <font color="#4E9A06"><b> Running</b></font> `target/debug/examples/usage`
//! <font color="#A1A1A1">Jul 05 19:16:02.853 </font><font color="#4E9A06"> INFO</font> <b>read_config</b>:<b>read_file{</b>path=&quot;fake_file&quot;<b>}</b>: Reading file
//! <pre><span style="color: #06989A"><b>color-eyre</b></span> on <span style="color: #75507B"><b> hooked</b></span> <span style="color: #CC0000"><b>[$!] </b></span>is <span style="color: #FF8700"><b>📦 v0.5.0</b></span> via <span style="color: #CC0000"><b>🦀 v1.44.0</b></span>
//! <span style="color: #CC0000"><b>❯</b></span> RUST_LIB_BACKTRACE=1 cargo run --example usage
//! <span style="color: #4E9A06"><b> Finished</b></span> dev [unoptimized + debuginfo] target(s) in 0.04s
//! <span style="color: #4E9A06"><b> Running</b></span> `target/debug/examples/usage`
//! <span style="color: #A1A1A1">Jul 05 19:16:02.853 </span><span style="color: #4E9A06"> INFO</span> <b>read_config</b>:<b>read_file{</b>path=&quot;fake_file&quot;<b>}</b>: Reading file
//! Error:
//! 0: <font color="#F15D22">Unable to read config</font>
//! 1: <font color="#F15D22">No such file or directory (os error 2)</font>
//! 0: <span style="color: #F15D22">Unable to read config</span>
//! 1: <span style="color: #F15D22">No such file or directory (os error 2)</span>
//!
//! ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ SPANTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
//!
//! 0: <font color="#F15D22">usage::read_file</font> with <font color="#34E2E2">path=&quot;fake_file&quot;</font>
//! at <font color="#75507B">examples/usage.rs</font>:<font color="#75507B">32</font>
//! 1: <font color="#F15D22">usage::read_config</font>
//! at <font color="#75507B">examples/usage.rs</font>:<font color="#75507B">38</font>
//! 0: <span style="color: #F15D22">usage::read_file</span> with <span style="color: #34E2E2">path=&quot;fake_file&quot;</span>
//! at <span style="color: #75507B">examples/usage.rs</span>:<span style="color: #75507B">32</span>
//! 1: <span style="color: #F15D22">usage::read_config</span>
//! at <span style="color: #75507B">examples/usage.rs</span>:<span style="color: #75507B">38</span>
//!
//! ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ BACKTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
//! <font color="#34E2E2"> ⋮ 5 frames hidden ⋮ </font>
//! 6: <font color="#F15D22">usage::read_file</font><font color="#88807C">::haee210cb22460af3</font>
//! at <font color="#75507B">/home/jlusby/git/yaahc/color-eyre/examples/usage.rs</font>:<font color="#75507B">35</font>
//! 7: <font color="#F15D22">usage::read_config</font><font color="#88807C">::ha649ef4ec333524d</font>
//! at <font color="#75507B">/home/jlusby/git/yaahc/color-eyre/examples/usage.rs</font>:<font color="#75507B">40</font>
//! 8: <font color="#F15D22">usage::main</font><font color="#88807C">::hbe443b50eac38236</font>
//! at <font color="#75507B">/home/jlusby/git/yaahc/color-eyre/examples/usage.rs</font>:<font color="#75507B">11</font>
//! <font color="#34E2E2"> ⋮ 10 frames hidden ⋮ </font>
//! <span style="color: #34E2E2"> ⋮ 5 frames hidden ⋮ </span>
//! 6: <span style="color: #F15D22">usage::read_file</span><span style="color: #88807C">::haee210cb22460af3</span>
//! at <span style="color: #75507B">/home/jlusby/git/yaahc/color-eyre/examples/usage.rs</span>:<span style="color: #75507B">35</span>
//! 7: <span style="color: #F15D22">usage::read_config</span><span style="color: #88807C">::ha649ef4ec333524d</span>
//! at <span style="color: #75507B">/home/jlusby/git/yaahc/color-eyre/examples/usage.rs</span>:<span style="color: #75507B">40</span>
//! 8: <span style="color: #F15D22">usage::main</span><span style="color: #88807C">::hbe443b50eac38236</span>
//! at <span style="color: #75507B">/home/jlusby/git/yaahc/color-eyre/examples/usage.rs</span>:<span style="color: #75507B">11</span>
//! <span style="color: #34E2E2"> ⋮ 10 frames hidden ⋮ </span>
//!
//! <font color="#34E2E2">Suggestion</font>: try using a file that exists next time</pre>
//! <span style="color: #34E2E2">Suggestion</span>: try using a file that exists next time</pre>
//!
//! <br>
//!
@ -168,26 +168,26 @@
//! the full format, which in addition to the above will attempt to include source lines where the
//! error originated from, assuming it can find them on the disk.
//!
//! <pre><font color="#06989A"><b>color-eyre</b></font> on <font color="#75507B"><b> hooked</b></font> <font color="#CC0000"><b>[$!] </b></font>is <font color="#FF8700"><b>📦 v0.5.0</b></font> via <font color="#CC0000"><b>🦀 v1.44.0</b></font>
//! <font color="#CC0000"><b>❯</b></font> RUST_LIB_BACKTRACE=full cargo run --example usage
//! <font color="#4E9A06"><b> Finished</b></font> dev [unoptimized + debuginfo] target(s) in 0.05s
//! <font color="#4E9A06"><b> Running</b></font> `target/debug/examples/usage`
//! <font color="#A1A1A1">Jul 05 19:16:06.335 </font><font color="#4E9A06"> INFO</font> <b>read_config</b>:<b>read_file{</b>path=&quot;fake_file&quot;<b>}</b>: Reading file
//! <pre><span style="color: #06989A"><b>color-eyre</b></span> on <span style="color: #75507B"><b> hooked</b></span> <span style="color: #CC0000"><b>[$!] </b></span>is <span style="color: #FF8700"><b>📦 v0.5.0</b></span> via <span style="color: #CC0000"><b>🦀 v1.44.0</b></span>
//! <span style="color: #CC0000"><b>❯</b></span> RUST_LIB_BACKTRACE=full cargo run --example usage
//! <span style="color: #4E9A06"><b> Finished</b></span> dev [unoptimized + debuginfo] target(s) in 0.05s
//! <span style="color: #4E9A06"><b> Running</b></span> `target/debug/examples/usage`
//! <span style="color: #A1A1A1">Jul 05 19:16:06.335 </span><span style="color: #4E9A06"> INFO</span> <b>read_config</b>:<b>read_file{</b>path=&quot;fake_file&quot;<b>}</b>: Reading file
//! Error:
//! 0: <font color="#F15D22">Unable to read config</font>
//! 1: <font color="#F15D22">No such file or directory (os error 2)</font>
//! 0: <span style="color: #F15D22">Unable to read config</span>
//! 1: <span style="color: #F15D22">No such file or directory (os error 2)</span>
//!
//! ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ SPANTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
//!
//! 0: <font color="#F15D22">usage::read_file</font> with <font color="#34E2E2">path=&quot;fake_file&quot;</font>
//! at <font color="#75507B">examples/usage.rs</font>:<font color="#75507B">32</font>
//! 0: <span style="color: #F15D22">usage::read_file</span> with <span style="color: #34E2E2">path=&quot;fake_file&quot;</span>
//! at <span style="color: #75507B">examples/usage.rs</span>:<span style="color: #75507B">32</span>
//! 30 │ }
//! 31 │
//! <b> 32 &gt; #[instrument]</b>
//! 33 │ fn read_file(path: &amp;str) -&gt; Result&lt;(), Report&gt; {
//! 34 │ info!(&quot;Reading file&quot;);
//! 1: <font color="#F15D22">usage::read_config</font>
//! at <font color="#75507B">examples/usage.rs</font>:<font color="#75507B">38</font>
//! 1: <span style="color: #F15D22">usage::read_config</span>
//! at <span style="color: #75507B">examples/usage.rs</span>:<span style="color: #75507B">38</span>
//! 36 │ }
//! 37 │
//! <b> 38 &gt; #[instrument]</b>
@ -195,31 +195,31 @@
//! 40 │ read_file(&quot;fake_file&quot;)
//!
//! ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ BACKTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
//! <font color="#34E2E2"> ⋮ 5 frames hidden ⋮ </font>
//! 6: <font color="#F15D22">usage::read_file</font><font color="#88807C">::haee210cb22460af3</font>
//! at <font color="#75507B">/home/jlusby/git/yaahc/color-eyre/examples/usage.rs</font>:<font color="#75507B">35</font>
//! <span style="color: #34E2E2"> ⋮ 5 frames hidden ⋮ </span>
//! 6: <span style="color: #F15D22">usage::read_file</span><span style="color: #88807C">::haee210cb22460af3</span>
//! at <span style="color: #75507B">/home/jlusby/git/yaahc/color-eyre/examples/usage.rs</span>:<span style="color: #75507B">35</span>
//! 33 │ fn read_file(path: &amp;str) -&gt; Result&lt;(), Report&gt; {
//! 34 │ info!(&quot;Reading file&quot;);
//! <font color="#D3D7CF"><b> 35 &gt; Ok(std::fs::read_to_string(path).map(drop)?)</b></font>
//! <span style="color: #D3D7CF"><b> 35 &gt; Ok(std::fs::read_to_string(path).map(drop)?)</b></span>
//! 36 │ }
//! 37 │
//! 7: <font color="#F15D22">usage::read_config</font><font color="#88807C">::ha649ef4ec333524d</font>
//! at <font color="#75507B">/home/jlusby/git/yaahc/color-eyre/examples/usage.rs</font>:<font color="#75507B">40</font>
//! 7: <span style="color: #F15D22">usage::read_config</span><span style="color: #88807C">::ha649ef4ec333524d</span>
//! at <span style="color: #75507B">/home/jlusby/git/yaahc/color-eyre/examples/usage.rs</span>:<span style="color: #75507B">40</span>
//! 38 │ #[instrument]
//! 39 │ fn read_config() -&gt; Result&lt;(), Report&gt; {
//! <font color="#D3D7CF"><b> 40 &gt; read_file(&quot;fake_file&quot;)</b></font>
//! <span style="color: #D3D7CF"><b> 40 &gt; read_file(&quot;fake_file&quot;)</b></span>
//! 41 │ .wrap_err(&quot;Unable to read config&quot;)
//! 42 │ .suggestion(&quot;try using a file that exists next time&quot;)
//! 8: <font color="#F15D22">usage::main</font><font color="#88807C">::hbe443b50eac38236</font>
//! at <font color="#75507B">/home/jlusby/git/yaahc/color-eyre/examples/usage.rs</font>:<font color="#75507B">11</font>
//! 8: <span style="color: #F15D22">usage::main</span><span style="color: #88807C">::hbe443b50eac38236</span>
//! at <span style="color: #75507B">/home/jlusby/git/yaahc/color-eyre/examples/usage.rs</span>:<span style="color: #75507B">11</span>
//! 9 │ color_eyre::install()?;
//! 10 │
//! <font color="#D3D7CF"><b> 11 &gt; Ok(read_config()?)</b></font>
//! <span style="color: #D3D7CF"><b> 11 &gt; Ok(read_config()?)</b></span>
//! 12 │ }
//! 13 │
//! <font color="#34E2E2"> ⋮ 10 frames hidden ⋮ </font>
//! <span style="color: #34E2E2"> ⋮ 10 frames hidden ⋮ </span>
//!
//! <font color="#34E2E2">Suggestion</font>: try using a file that exists next time</pre>
//! <span style="color: #34E2E2">Suggestion</span>: try using a file that exists next time</pre>
//!
//! ### Custom `Section`s for error reports via [`Help`] trait
//!
@ -266,27 +266,27 @@
//! Running `cargo run --example custom_section` shows us how these sections are
//! included in the output:
//!
//! <pre><font color="#06989A"><b>color-eyre</b></font> on <font color="#75507B"><b> hooked</b></font> <font color="#CC0000"><b>[$!] </b></font>is <font color="#FF8700"><b>📦 v0.5.0</b></font> via <font color="#CC0000"><b>🦀 v1.44.0</b></font> took <font color="#C4A000"><b>2s</b></font>
//! <font color="#CC0000"><b>❯</b></font> cargo run --example custom_section
//! <font color="#4E9A06"><b> Finished</b></font> dev [unoptimized + debuginfo] target(s) in 0.04s
//! <font color="#4E9A06"><b> Running</b></font> `target/debug/examples/custom_section`
//! <pre><span style="color: #06989A"><b>color-eyre</b></span> on <span style="color: #75507B"><b> hooked</b></span> <span style="color: #CC0000"><b>[$!] </b></span>is <span style="color: #FF8700"><b>📦 v0.5.0</b></span> via <span style="color: #CC0000"><b>🦀 v1.44.0</b></span> took <span style="color: #C4A000"><b>2s</b></span>
//! <span style="color: #CC0000"><b>❯</b></span> cargo run --example custom_section
//! <span style="color: #4E9A06"><b> Finished</b></span> dev [unoptimized + debuginfo] target(s) in 0.04s
//! <span style="color: #4E9A06"><b> Running</b></span> `target/debug/examples/custom_section`
//! Error:
//! 0: <font color="#F15D22">Unable to read config</font>
//! 1: <font color="#F15D22">cmd exited with non-zero status code</font>
//! 0: <span style="color: #F15D22">Unable to read config</span>
//! 1: <span style="color: #F15D22">cmd exited with non-zero status code</span>
//!
//! Stderr:
//! cat: fake_file: No such file or directory
//!
//! ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ SPANTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
//!
//! 0: <font color="#F15D22">custom_section::output2</font> with <font color="#34E2E2">self=&quot;cat&quot; &quot;fake_file&quot;</font>
//! at <font color="#75507B">examples/custom_section.rs</font>:<font color="#75507B">14</font>
//! 1: <font color="#F15D22">custom_section::read_file</font> with <font color="#34E2E2">path=&quot;fake_file&quot;</font>
//! at <font color="#75507B">examples/custom_section.rs</font>:<font color="#75507B">58</font>
//! 2: <font color="#F15D22">custom_section::read_config</font>
//! at <font color="#75507B">examples/custom_section.rs</font>:<font color="#75507B">63</font>
//! 0: <span style="color: #F15D22">custom_section::output2</span> with <span style="color: #34E2E2">self=&quot;cat&quot; &quot;fake_file&quot;</span>
//! at <span style="color: #75507B">examples/custom_section.rs</span>:<span style="color: #75507B">14</span>
//! 1: <span style="color: #F15D22">custom_section::read_file</span> with <span style="color: #34E2E2">path=&quot;fake_file&quot;</span>
//! at <span style="color: #75507B">examples/custom_section.rs</span>:<span style="color: #75507B">58</span>
//! 2: <span style="color: #F15D22">custom_section::read_config</span>
//! at <span style="color: #75507B">examples/custom_section.rs</span>:<span style="color: #75507B">63</span>
//!
//! <font color="#34E2E2">Suggestion</font>: try using a file that exists next time</pre>
//! <span style="color: #34E2E2">Suggestion</span>: try using a file that exists next time</pre>
//!
//! Only the `Stderr:` section actually gets included. The `cat` command fails,
//! so stdout ends up being empty and is skipped in the final report. This gives