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

Docs overhaul #124

Merged
merged 7 commits into from
Feb 25, 2022
Merged

Docs overhaul #124

merged 7 commits into from
Feb 25, 2022

Conversation

virtualritz
Copy link
Contributor

@virtualritz virtualritz commented Feb 25, 2022

  • Fixed all intra-doc links and their formatting.
  • Added clarification for anyhow/eyre users.
  • Removed MietteError::SetPrinterFailure as it wasn't used any more and referenced a non-existing function (set_printer()).
  • Moved the README text into lib.rs and generated README.md via cargo readme (with README.tpl template to have intra-doc links resolved correctly).
  • Added rustfmt.toml to help with automatic line wrapping of comments via cargo fmt.
  • Made the ErrorHook type public. It is referenced in the public docs and set_hook() (which is public) so I assumed this was intended.

Copy link
Owner

@zkat zkat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks great! Thanks so much! :)

@zkat
Copy link
Owner

zkat commented Feb 25, 2022

Looks like the latest stable broke clippy. Feel free to rebase onto the latest main and all should be green.

@virtualritz
Copy link
Contributor Author

Btw. – the command to generate README.md from the contents of lib.rs is:

cargo readme >README.md

@zkat zkat merged commit 5d23c0d into zkat:main Feb 25, 2022
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.

2 participants