What is the recommended way to submit errata/revision suggestions for rust book/documentations?

#1

I’m reading rust books and occasionally I found typos in the book. Example:

https://doc.rust-lang.org/book/ch07-00-packages-crates-and-modules.html
“encompases” should be “encompasses”

How can I make a correction (or at least a suggestion / report) for such cases? Thank you!

#2

I think the best way is to just send the correction as a pull request to the book’s repo, or at least open an issue there.

This one is here: https://github.com/rust-lang/book

2 Likes
#4

Thanks for the reply.

I’m checking the source scripts here:
https://github.com/rust-lang/book/tree/master/src
It doesn’t match what I’m seeing on the rust website. E.g. I didn’t find the aforementioned content:
https://doc.rust-lang.org/book/ch07-00-packages-crates-and-modules.html
in the book’s sources.

Am I looking at the right place? Or the book’s content on rust official website is outdated?

Sorry if my questions are nooby. I’m not using GibHub regularly and I’m just wandering around to look for the right source scripts on the GitHub page.

#5

The source indeed is newer than the main book.
The source is rendered as the nightly version here: https://doc.rust-lang.org/nightly/book/ch07-00-managing-growing-projects-with-packages-crates-and-modules.html
Chapter 7 was recently rewritten.
The book should be shipped with each release, thus what you currently see on nightly will eventually become beta, then stable.

2 Likes
#6

I see. Thanks for the reply! I’m curious to ask: what’s the release schedule? Is it weekly or monthly or something else?

#7

Release cycle is six weeks. i.e., lag between nightly and stable is 12-18 weeks.

1 Like
#8

Got it. Thanks!