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.

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

Jump to bottom

Intro: emphasis on year-named editions can make the book seem outdated #2852

Closed
2 tasks done
jruderman opened this issue Sep 9, 2021 · 1 comment · Fixed by rust-lang/rust#92546
Closed
2 tasks done

Intro: emphasis on year-named editions can make the book seem outdated #2852

jruderman opened this issue Sep 9, 2021 · 1 comment · Fixed by rust-lang/rust#92546
Milestone
preface

Comments

@jruderman
Copy link
Contributor

  • I have checked the latest main branch to see if this has already been fixed
  • I have searched existing issues and pull requests for duplicates

URL to the section(s) of the book with this problem:

https://doc.rust-lang.org/book/

Description of the problem:

The emphasis on "2018 edition" on the first page made me think the book was outdated, because I didn't know about the distinction between Rust editions and Rust versions when I started reading.

This version of the text assumes you’re using Rust 1.54 or later with edition="2018" in Cargo.toml of all projects to use Rust 2018 Edition idioms.

Suggested fix:

  • Add "(2021 July)" next to "Rust 1.54"
  • Replace "to use Rust 2018 idioms" with "to use its newest edition-gated features"
  • Add a brief explanation of editions here and how they differ from versions
  • Indicate that "the 2018 edition" is current as of early 2021
  • Or, move this whole page to the 'Editions' appendix, and open the book with what is currently the Foreward
@jruderman
Copy link
Contributor Author

May be related to discussion in #2824

@carols10cents carols10cents added this to the preface milestone Sep 18, 2021
carols10cents added a commit that referenced this issue Dec 23, 2021
@carols10cents
Remove most of the 2018 edition text from the title page. Fixes #2852.
3c6567b
@ehuss ehuss mentioned this issue Jan 4, 2022
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Jan 4, 2022
@matthiaskrgr
Rollup merge of rust-lang#92546 - ehuss:update-books, r=ehuss
4b743f8 
Update books

## reference

3 commits in 06f9e61931bcf58b91dfe6c924057e42ce273ee1..f8ba2f12df60ee19b96de24ae5b73af3de8a446b
2021-12-17 07:31:40 -0800 to 2022-01-03 11:02:08 -0800
- Switch the default edition for examples to 2021 (rust-lang/reference#1125)
- Clarify behavior of x87 FP registers in inline assembly (rust-lang/reference#1126)
- Add inline assembly to the reference (rust-lang/reference#1105)

## book

36 commits in 8a0bb3c96e71927b80fa2286d7a5a5f2547c6aa4..d3740fb7aad0ea4a80ae20f64dee3a8cfc0c5c3c
2021-12-22 20:54:27 -0500 to 2022-01-03 21:46:04 -0500
- Add a concrete example of an optional value. Fixes rust-lang/book#2848.
- match isn't really an operator. Fixes rust-lang/book#2859
- Edits to edits of chapter 6
- Make fixes recommended by shellcheck
- Use shellcheck
- SIGH fix all the typos that were missed while spellcheck was broken
- SIGH add all the words to the dictionary that were missed while spellcheck was broken
- Remove test_harness from the dictionary
- sigh, the xkcd sandwich one
- Install aspell in CI
- set -eu in all bash scripts
- typo: assignement -> assignment
- Fix quotes
- Snapshot of ch12 for nostarch
- Use 'static lifetime earlier because that's more correct. Fixes rust-lang/book#2864.
- Add does_not_compile annotation to intermediate steps that don't compile
- Sidestep who provides output streams. Fixes rust-lang/book#2933.
- Remove note about primitive obsession. Fixes rust-lang/book#2863.
- Remove sentence encouraging writing tests on your own. Fixes rust-lang/book#2223.
- Bump mdBook version to 0.4.14 in workflow main.yml
- Past tense make better sense
- Past tense makes better sense
- Update the edition in all the listings' Cargo.toml
- Update the book to either say 2021 edition or not talk about editions
- Remove most of the 2018 edition text from the title page. Fixes rust-lang/book#2852.
- Fix word wrapping
- Emphasize return type is mandatory
- fix title capitalization
- Further edits to mention of --include-ignored, propagate to src
- feat: mention `cargo test -- --include-ignored`
- wording: get rid of "to from"
- interchanged position of `binary` and `library`
- Fix wrong word typo
- Further edits in rust-analyzer text
- appendix-04 IDE integration: Replaced rls by rust-analyzer
- Update link to Italian translation. Connects to rust-lang/book#2484.

## rustc-dev-guide

3 commits in 9bf0028..8754644
2021-12-20 21:53:57 +0900 to 2021-12-28 22:17:49 -0600
- Update link to moved section (rust-lang/rustc-dev-guide#1282)
- Fix link in contributing.md (rust-lang/rustc-dev-guide#1280)
- Streamline "Getting Started" (rust-lang/rustc-dev-guide#1279)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
preface
Development

Successfully merging a pull request may close this issue.

Update books ehuss/rust
2 participants
@carols10cents @jruderman