Skip to content

[docs] Clean up wording of crate root docs #2076

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: v0.8.x
Choose a base branch
from
Open

[docs] Clean up wording of crate root docs #2076

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 6 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,16 @@ made in the doc comment on `src/lib.rs` or in `tools/generate-readme`.

# zerocopy

*<span style="font-size: 100%; color:grey;">Need more out of zerocopy?
Submit a [customer request issue][customer-request-issue]!</span>*
*<span style="font-size: 100%; color:grey;">Have questions? Need help? Ask
the maintainers on [GitHub][github-q-a] or on [Discord][discord]! Need more
out of zerocopy? Submit a [customer request
issue][customer-request-issue]!</span>*

***<span style="font-size: 140%">Fast, safe, <span
style="color:red;">compile error</span>. Pick two.</span>***

Zerocopy makes zero-cost memory manipulation effortless. We write `unsafe`
so you don't have to.

*Thanks for using zerocopy 0.8! For an overview of what changes from 0.7,
check out our [release notes][release-notes], which include a step-by-step
guide for upgrading from 0.7.*

*Have questions? Need help? Ask the maintainers on [GitHub][github-q-a] or
on [Discord][discord]!*
Zerocopy is a Swiss Army knife for reasoning about and manipulating types
and their memory layouts. We write `unsafe` correctly so you don't have to.

[customer-request-issue]: https://github.com/google/zerocopy/issues/new/choose
[release-notes]: https://github.com/google/zerocopy/discussions/1680
Expand Down
17 changes: 6 additions & 11 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,16 @@
//
// cargo -q run --manifest-path tools/Cargo.toml -p generate-readme > README.md

//! *<span style="font-size: 100%; color:grey;">Need more out of zerocopy?
//! Submit a [customer request issue][customer-request-issue]!</span>*
//! *<span style="font-size: 100%; color:grey;">Have questions? Need help? Ask
//! the maintainers on [GitHub][github-q-a] or on [Discord][discord]! Need more
//! out of zerocopy? Submit a [customer request
//! issue][customer-request-issue]!</span>*
//!
//! ***<span style="font-size: 140%">Fast, safe, <span
//! style="color:red;">compile error</span>. Pick two.</span>***
//!
//! Zerocopy makes zero-cost memory manipulation effortless. We write `unsafe`
//! so you don't have to.
//!
//! *Thanks for using zerocopy 0.8! For an overview of what changes from 0.7,
//! check out our [release notes][release-notes], which include a step-by-step
//! guide for upgrading from 0.7.*
//!
//! *Have questions? Need help? Ask the maintainers on [GitHub][github-q-a] or
//! on [Discord][discord]!*
//! Zerocopy is a Swiss Army knife for reasoning about and manipulating types
//! and their memory layouts. We write `unsafe` correctly so you don't have to.
//!
//! [customer-request-issue]: https://github.com/google/zerocopy/issues/new/choose
//! [release-notes]: https://github.com/google/zerocopy/discussions/1680
Expand Down
Loading