Update and Translating Project Documentation #15
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tings/ch17-async-await/listing-17-02/ring-0.17.13 Bump ring from 0.17.8 to 0.17.13 in /listings/ch17-async-await/listing-17-02
Ch. 17: fix tiny example consistency issue
Typo: "2" should be "2 seconds"
…_file_fail Persist printing error, NOT ErrorKind
Bonus: drop now-unnecessary `use std::future::Future` bits given it is now part of the prelude as of the 2024 edition! Fixes rust-lang#4275
Ch. 17: mention `use std::pin::{Pin, pin};` on introduction
This is a trivial thing, but I found the previous “replace a terminal newline and then count the rest” rather less than obvious. Make the logic more explicit and, as a fun bonus, skip allocating an extra string along the way. (Not that it matters, in this case, but it’s always nice to make that kind of improvement.)
Previously, when we incorporated Ferris into the container for the buttons, we were bringing along the visibility of the buttons even when it was important to know that the code wouldn’t compile. This changes that by showing and hiding the buttons themselves rather than their container. Fixes rust-lang#4274
…simplify Ferris: always show, even when it’s small
Clarified the misunderstanding b/w crates, module, items
…ions Ch 10.1 minor clarifications
Ch. 20: tell folks to see the Reference for more ABI info
Ch. 18: correct discussion of delegation in `Post` methods
The code as actually written *did* conform to the expetaction of the text, but only because it was in a `lib.rs` file and so in a module distinct from the scope directly accessible from `main.rs`; as shown in the text presentation, however, it was not obvious that it was in a `lib.rs`, and that detail was elided. Rename the `lib.rs` to `guessing_game.rs` and declare it as a module in the `main.rs` file, update the `Listing` to name it, and update the text to call out the creation of the module.
Ch. 9: correctly demonstrate privacy with module
The former phrasing seemed to suggest that we _must not_ annotate types _unless_ there are multiple possibilities. In fact, we are allowed to add redundant annotations. Cases where no annotation is needed _despite_ multiple possible types -- e.g. `let n = 8` -- are, presumably, intentionally left out here, so not touching that.
Co-authored-by: Chris Krycho <hello@chriskrycho.com>
Ch. 10.3: clarify language detail
Ch. 20: correct listing number
…rase-improvemnt Ch. 17: another tweak to how we phrase things about sections
update tests after new attribute id added Co-authored-by: Chris Krycho <hello@chriskrycho.com>
Anchors on listings
Adopt the idiomatic pattern of separating `std` from third-party `use` statements, with the result that we get the ordering we want for Ch. 07 for “free”. Fixes rust-lang#3121
…use-statements Ch. 02: Consistent ordering of `use` statements
Looks like I forgot to save a few; some have weirdnesses i don't care to special case right now
Fix typo
Now that rand 0.9 actually exists 😅 Hopefully version 0.999.0 won't exist for a while!! This should address some of the confusion in rust-lang#4508 and shouldn't need further updating even as rand's version increases (unless they go to 1.0 😳)
The default is OR search, which is less popular (and therefore more surprising) than AND search
Changelog: https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-051 This also changes it so that it is not necessary to install `mbdook-trpl`. This should make it easier to work with the book and the extension.
This changes the name of the `TrplNote` mdbook preprocessor so that it matches the name used in `book.toml`. The reason this needs to be in sync is that in upstream we use `MDBook::with_preprocessor` to replace the preprocessor, but unfortunately it grabs the name from the preprocessor itself. If these are out of sync, it ends up not being able to replace the old preprocessor config. The API in mdbook should probably be better to make it easier to manage the config. For now, this is probably the easiest fix.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
16 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update to the latest version of the source fork and Translate project documentation into Indonesian