1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-08-09 16:58:19 +02:00

Expand "Docs" plus light copy-editing (#1568)

I don't like shortening words, so I prefer "Documentation" over "Docs".
I find this less jargony and thus easier to read (and potentially also
easier to translate).
This commit is contained in:
Martin Geisler
2023-12-07 21:04:36 +01:00
committed by GitHub
parent 45a8ec4e78
commit 1ec2e8db9e
2 changed files with 5 additions and 6 deletions

View File

@ -93,7 +93,7 @@
- [Welcome](welcome-day-2-afternoon.md) - [Welcome](welcome-day-2-afternoon.md)
- [Standard Library Types](std-types.md) - [Standard Library Types](std-types.md)
- [Standard Library](std-types/std.md) - [Standard Library](std-types/std.md)
- [Language Docs](std-types/docs.md) - [Documentation](std-types/docs.md)
- [`Option`](std-types/option.md) - [`Option`](std-types/option.md)
- [`Result`](std-types/result.md) - [`Result`](std-types/result.md)
- [`String`](std-types/string.md) - [`String`](std-types/string.md)

View File

@ -2,14 +2,13 @@
minutes: 5 minutes: 5
--- ---
# Language Docs # Documentation
Rust comes with extensive documentation of the language and the standard library. Rust comes with extensive documentation. For example:
For example:
* All of the details about [loops](https://doc.rust-lang.org/stable/reference/expressions/loop-expr.html). * All of the details about [loops](https://doc.rust-lang.org/stable/reference/expressions/loop-expr.html).
* Primitive types like [`u8`](https://doc.rust-lang.org/stable/std/primitive.u8.html). * Primitive types like [`u8`](https://doc.rust-lang.org/stable/std/primitive.u8.html).
* Standard-library items like [`Option`](https://doc.rust-lang.org/stable/std/option/enum.Option.html) or [`BinaryHeap`](https://doc.rust-lang.org/stable/std/collections/struct.BinaryHeap.html). * Standard library types like [`Option`](https://doc.rust-lang.org/stable/std/option/enum.Option.html) or [`BinaryHeap`](https://doc.rust-lang.org/stable/std/collections/struct.BinaryHeap.html).
In fact, you can document your own code: In fact, you can document your own code:
@ -40,6 +39,6 @@ or `/*! .. */`, called "inner doc comments":
<details> <details>
* Show students the generated docs for the `rand` crate at * Show students the generated docs for the `rand` crate at
[`docs.rs/rand`](https://docs.rs/rand). <https://docs.rs/rand>.
</details> </details>