Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): enclose inline code in backticks #170

Merged
merged 3 commits into from
Apr 25, 2024

Conversation

LeoniePhiline
Copy link
Contributor

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
Copy link
Contributor Author

LeoniePhiline commented Apr 24, 2024

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

@yaahc
Copy link
Collaborator

yaahc commented Apr 25, 2024

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

@yaahc yaahc merged commit 586e359 into eyre-rs:master Apr 25, 2024
29 checks passed
@yaahc
Copy link
Collaborator

yaahc commented Apr 25, 2024

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

@LeoniePhiline
Copy link
Contributor Author

Thank you! ☺️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: enclosing in backticks
3 participants