Merge pull request #1888 from ShapelessCat/minor-improvements

Minor improvements

Author: marioidival

.gitignore

@@ -2,5 +2,7 @@ book
 
 po/messages.pot
 
+.vscode/
+
 # Auto-generated files from macOS
 .DS_Store

CONTRIBUTING.md

@@ -10,7 +10,7 @@ abide by the [Rust code of conduct], which you can find at that link or in the
 
 ## License
 
-RBE is dual licenced under the MIT and Apache 2.0 licenses, and so are all
+RBE is dual licensed under the MIT and Apache 2.0 licenses, and so are all
 contributions. Please see the [`LICENSE-MIT`] and [`LICENSE-APACHE`] files in
 this directory for more details.
 
@@ -55,7 +55,7 @@ $ mdbook build
 
 **The following warnings can be ignored safely.**
 
-```
+```text
 [WARN] (mdbook::preprocess::cmd): The command wasn't found, is the "gettext" preprocessor installed?
 [WARN] (mdbook::preprocess::cmd):   Command: mdbook-gettext
 ```

README.md

@@ -26,7 +26,7 @@ read all content offline, however!
 
 **The following warnings can be ignored safely.**
 
-```
+```text
 [WARN] (mdbook::preprocess::cmd): The command wasn't found, is the "gettext" preprocessor installed?
 [WARN] (mdbook::preprocess::cmd):   Command: mdbook-gettext
 ```

TRANSLATING.md

@@ -37,7 +37,7 @@ MDBOOK_OUTPUT='{"xgettext": {"pot-file": "messages.pot"}}' \
 msginit -i po/messages.pot -l xx -o po/xx.po
 ```
 
-#### Updating the exising translation resource
+#### Updating the existing translation resource
 
 ```bash
 msgmerge --update po/xx.po po/messages.pot

src/attribute.md

@@ -17,11 +17,12 @@ can be used to/for:
 Attributes look like `#[outer_attribute]` or `#![inner_attribute]`,
 with the difference between them being where they apply.
 
-- `#[outer_attribute]` applies to the [item][item] immediately
+* `#[outer_attribute]` applies to the [item][item] immediately
   following it. Some examples of items are: a function, a module
   declaration, a constant, a structure, an enum. Here is an example
   where attribute `#[derive(Debug)]` applies to the struct
   `Rectangle`:
+
   ```rust
   #[derive(Debug)]
   struct Rectangle {
@@ -30,11 +31,12 @@ with the difference between them being where they apply.
   }
   ```
 
-- `#![inner_attribute]` applies to the enclosing [item][item] (typically a
+* `#![inner_attribute]` applies to the enclosing [item][item] (typically a
   module or a crate). In other words, this attribute is interpreted as
   applying to the entire scope in which it's placed. Here is an example
   where `#![allow(unused_variables)]` applies to the whole crate (if
   placed in `main.rs`):
+
   ```rust
   #![allow(unused_variables)]
 

src/cargo/deps.md

@@ -91,6 +91,5 @@ rebuilds what it has not already built, similar to `make`).
 
 Voila! That's all there is to it!
 
-
 [manifest]: https://doc.rust-lang.org/cargo/reference/manifest.html
 [dependencies]: https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html

src/cargo/test.md

@@ -2,8 +2,7 @@
 
 As we know testing is integral to any piece of software! Rust has first-class
 support for unit and integration testing ([see this
-chapter](https://doc.rust-lang.org/book/ch11-00-testing.html) in
-TRPL).
+chapter](https://doc.rust-lang.org/book/ch11-00-testing.html) in TRPL).
 
 From the testing chapters linked above, we see how to write unit tests and
 integration tests. Organizationally, we can place unit tests in the modules they
@@ -20,13 +19,13 @@ foo
     └── my_other_test.rs
 ```
 
-Each file in `tests` is a separate 
+Each file in `tests` is a separate
 [integration test](https://doc.rust-lang.org/book/ch11-03-test-organization.html#integration-tests),
 i.e. a test that is meant to test your library as if it were being called from a dependent
 crate.
 
-The [Testing][testing] chapter elaborates on the three different testing styles: 
-[Unit][unit_testing], [Doc][doc_testing], and [Integration][integration_testing]. 
+The [Testing][testing] chapter elaborates on the three different testing styles:
+[Unit][unit_testing], [Doc][doc_testing], and [Integration][integration_testing].
 
 `cargo` naturally provides an easy way to run all of your tests!
 
@@ -71,7 +70,7 @@ test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 2 filtered out
 ```
 
 One word of caution: Cargo may run multiple tests concurrently, so make sure
-that they don't race with each other. 
+that they don't race with each other.
 
 One example of this concurrency causing issues is if two tests output to a
 file, such as below:
@@ -120,6 +119,7 @@ mod tests {
 ```
 
 Although the intent is to get the following:
+
 ```shell
 $ cat ferris.txt
 Ferris
@@ -133,7 +133,9 @@ Corro
 Corro
 Corro
 ```
+
 What actually gets put into `ferris.txt` is this:
+
 ```shell
 $ cargo test test_file && cat ferris.txt
 Corro

src/compatibility.md

@@ -1,6 +1,6 @@
 # Compatibility
 
-The Rust language is fastly evolving, and because of this certain compatibility
+The Rust language is evolving rapidly, and because of this certain compatibility
 issues can arise, despite efforts to ensure forwards-compatibility wherever
 possible.
 

src/conversion/from_into.md

@@ -73,8 +73,8 @@ fn main() {
 
 `From` and `Into` are designed to be complementary.
 We do not need to provide an implementation for both traits.
-If you have implemented the `From` trait for your type, `Into` will call it 
-when necessary. Note, however, that the converse is not true: implementing `Into` for your type will not automatically provide it with an implementation of `From`. 
+If you have implemented the `From` trait for your type, `Into` will call it
+when necessary. Note, however, that the converse is not true: implementing `Into` for your type will not automatically provide it with an implementation of `From`.
 
 ```rust,editable
 use std::convert::From;

src/conversion/string.md

@@ -4,7 +4,7 @@
 
 To convert any type to a `String` is as simple as implementing the [`ToString`]
 trait for the type. Rather than doing so directly, you should implement the
-[`fmt::Display`][Display] trait which automagically provides [`ToString`] and
+[`fmt::Display`][Display] trait which automatically provides [`ToString`] and
 also allows printing the type as discussed in the section on [`print!`][print].
 
 ```rust,editable