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

Remove cargo-readme checks #32

Open
bstrie opened this issue Nov 21, 2022 · 0 comments
Open

Remove cargo-readme checks #32

bstrie opened this issue Nov 21, 2022 · 0 comments
Assignees

Comments

@bstrie
Copy link
Contributor

bstrie commented Nov 21, 2022

Crate-level documentation wants to live in two places simultaneously: in the README.md file (so that it shows up nicely on Github) and in the crate-level doc comment (so that it shows up nicely on docs.rs). In the old days, the solution was to have the documentation duplicated in both places and use a tool like cargo-readme to make sure they stayed in sync. But since Rust 1.54 it's now possible to declare a crate-level doc comment via #![doc = include_str!("../README.md")], which allows us to remove the duplicated documentation and remove the need to have cargo-readme run in CI.

Previously some of the crates in the Enarx repo were on MSRVs that predated 1.54. However, as part of #28 we're increasing all of our MSRVs to at least 1.56 (in order to leverage the rust-version key in Cargo.toml), so once that's done we can do this for all the crates in the repo that are still using cargo-readme.

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

No branches or pull requests

1 participant