fix(docs): enclose inline code in backticks

eyre-rs / eyre

A trait object based error handling type for easy idiomatic error handling and reporting in Rust applications

Apache License 2.0

1.35k stars 63 forks source link

Closed LeoniePhiline closed 4 months ago

LeoniePhiline commented 4 months ago

Fixes #169

Besides enclosing inline code in backticks, I also made two tiny documentation improvements - please let me know if you want them undone:

In the Report::msg docs, the user is referred to Report::new. I changed this from plain inline code into a link.
I expanded "Display impl" to "Display implementation", since impl is a Rust token, but
- "Display impl" looked silly, and
- "impl Display" disturbed the flow of reading.

LeoniePhiline commented 4 months ago

The CI failures are unrelated: Shall I rebase onto test-ci / #161 / #163?

yaahc commented 4 months ago

@LeoniePhiline I think we'll land 163 then you can go ahead and rebase on master

yaahc commented 4 months ago

turns out I was able to do the rebase myself easily ^_^

LeoniePhiline commented 4 months ago

Thank you! ☺️