mirror of
https://github.com/google/comprehensive-rust.git
synced 2024-12-15 22:37:28 +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:
parent
45a8ec4e78
commit
1ec2e8db9e
@ -93,7 +93,7 @@
|
||||
- [Welcome](welcome-day-2-afternoon.md)
|
||||
- [Standard Library Types](std-types.md)
|
||||
- [Standard Library](std-types/std.md)
|
||||
- [Language Docs](std-types/docs.md)
|
||||
- [Documentation](std-types/docs.md)
|
||||
- [`Option`](std-types/option.md)
|
||||
- [`Result`](std-types/result.md)
|
||||
- [`String`](std-types/string.md)
|
||||
|
@ -2,14 +2,13 @@
|
||||
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).
|
||||
* 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:
|
||||
|
||||
@ -40,6 +39,6 @@ or `/*! .. */`, called "inner doc comments":
|
||||
<details>
|
||||
|
||||
* Show students the generated docs for the `rand` crate at
|
||||
[`docs.rs/rand`](https://docs.rs/rand).
|
||||
<https://docs.rs/rand>.
|
||||
|
||||
</details>
|
||||
|
Loading…
Reference in New Issue
Block a user