From 018cc693d901d5bf739cd48a9236a8cd05c6ca65 Mon Sep 17 00:00:00 2001 From: Joshua Liebow-Feeser Date: Mon, 18 Nov 2024 14:54:59 -0800 Subject: [PATCH] [docs] Clean up wording of crate root docs gherrit-pr-id: I7e6417b6418849369c6fbc0b9e9ca3bb15d57b33 --- README.md | 17 ++++++----------- src/lib.rs | 17 ++++++----------- 2 files changed, 12 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 4aeb157c67..a134cd2853 100644 --- a/README.md +++ b/README.md @@ -12,21 +12,16 @@ made in the doc comment on `src/lib.rs` or in `tools/generate-readme`. # zerocopy -*Need more out of zerocopy? -Submit a [customer request issue][customer-request-issue]!* +*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]!* ***Fast, safe, compile error. Pick two.*** -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 diff --git a/src/lib.rs b/src/lib.rs index c48223e7dc..eafaba85fa 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -12,21 +12,16 @@ // // cargo -q run --manifest-path tools/Cargo.toml -p generate-readme > README.md -//! *Need more out of zerocopy? -//! Submit a [customer request issue][customer-request-issue]!* +//! *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]!* //! //! ***Fast, safe, compile error. Pick two.*** //! -//! 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