From a15669562f00b7a8bc04d7a95a84b4d63b6c19c6 Mon Sep 17 00:00:00 2001 From: "Alan D. Salewski" Date: Sun, 14 Aug 2022 21:44:20 -0400 Subject: [PATCH] use title "The Rust Edition Guide" everywhere Makes consistent the following references to the title: "The Edition Guide" (book.toml -- document title) (src/SUMMARY.md) (README.md ["License" section text]) "The Rust Edition Guide" (README.md [heading]) "the Rust Edition Guide" (src/introduction.md) "this Edition Migration Guide" (src/editions/index.md) Signed-off-by: Alan D. Salewski --- README.md | 4 ++-- book.toml | 2 +- src/SUMMARY.md | 2 +- src/editions/index.md | 6 +++--- src/introduction.md | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 55949825..3f399438 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ online](https://doc.rust-lang.org/nightly/edition-guide/). ## License -The Edition Guide is dual licensed under `MIT`/`Apache2`, just like Rust itself. -See the `LICENSE-*` files in this repository for more details. +The Rust Edition Guide is dual licensed under `MIT`/`Apache2`, just like Rust +itself. See the `LICENSE-*` files in this repository for more details. ## Building locally diff --git a/book.toml b/book.toml index 8d8b2632..7841b647 100644 --- a/book.toml +++ b/book.toml @@ -2,7 +2,7 @@ authors = ["The Rust Project Developers"] multilingual = false src = "src" -title = "The Edition Guide" +title = "The Rust Edition Guide" [output.html] git-repository-url = "https://github.com/rust-lang/edition-guide" diff --git a/src/SUMMARY.md b/src/SUMMARY.md index dac77913..9ac69923 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,4 +1,4 @@ -# The Edition Guide +# The Rust Edition Guide [Introduction](introduction.md) diff --git a/src/editions/index.md b/src/editions/index.md index e12285c4..81864734 100644 --- a/src/editions/index.md +++ b/src/editions/index.md @@ -51,11 +51,11 @@ there might be some corner cases where manual changes are still required. The tooling tries hard to avoid changes to semantics that could affect the correctness or performance of the code. -In addition to tooling, we also maintain this Edition Migration Guide that covers +In addition to tooling, we also maintain this Rust Edition Guide that covers the changes that are part of an edition. This guide describes each change and gives pointers to where you can learn more about it. It also covers any corner cases or details you should be aware of. -This guide serves both as an overview of the edition +This guide serves as an overview of editions, +as a migration guide for specific editions, and as a quick troubleshooting reference if you encounter problems with the automated tooling. - diff --git a/src/introduction.md b/src/introduction.md index c23508b2..a36a620a 100644 --- a/src/introduction.md +++ b/src/introduction.md @@ -1,6 +1,6 @@ # Introduction -Welcome to the Rust Edition Guide! "Editions" are Rust's way of introducing +Welcome to The Rust Edition Guide! "Editions" are Rust's way of introducing changes into the language that would not otherwise be backwards compatible.