1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-12-15 14:27:50 +02:00
Commit Graph

983 Commits

Author SHA1 Message Date
Robin Stringer
6fac027dd6
Updates PR with code formatting
Backticks for inline and single line code blocks / examples.
2023-01-09 14:42:27 +00:00
Robin Stringer
9cd5d25821
Adds speaker notes to Compound Types section
Speaker notes for 6. Basic Syntax, 6.2 Compound Types section.
Briefly explains arrays and tuples properties.
Adds option for instructor to check for out of bounds errors using assert!().
2023-01-09 14:18:37 +00:00
Martin Geisler
3ff2d5f43a
Merge pull request #118 from google/exercise-code-snippets
Explain why exercises are not editable
2023-01-09 14:42:54 +01:00
Martin Geisler
affb2526fe Explain why exercises are not editable
From a discussion in #23.
2023-01-09 14:41:48 +01:00
Martin Geisler
bf657f5ff0 Show expanded speaker notes on print page
The `/print.html` page is concatenates all pages in the book and can
be reached from the printer icon in the top-right corner.

On this page, we will have many speaker notes. Since the page is for
people who want all information in one place, I think it makes sense
to render all these notes in their expanded form.

I wrote the logic for this as a separate little function since it has
to be different: we don’t want to add an `id` attribute to the
generated headers (since there will be more than one of them) and we
don’t want to generate links to open the notes into a separate window.
2023-01-09 14:37:07 +01:00
Martin Geisler
029aa8b139
Merge pull request #117 from google/thread-speaker-notes
Add notes to threads.md
2023-01-09 14:33:16 +01:00
Martin Geisler
e835ee6cdf Add notes to threads.md
From the discussion in #63.
2023-01-09 14:32:04 +01:00
Martin Geisler
1162c554c0
Merge pull request #128 from google/speaker-notes
Add speaker notes for the first few slides
2023-01-09 14:28:50 +01:00
Martin Geisler
f4b753b7c5 Speaker notes for “Rust Ecosystem” 2023-01-09 14:27:13 +01:00
Martin Geisler
62d206506f Speaker notes for “Running Cargo Locally” 2023-01-09 14:27:13 +01:00
Martin Geisler
3db19fd2e5 Speaker notes for “Using Cargo” 2023-01-09 14:27:13 +01:00
Martin Geisler
b1e11304a7 Speaker notes for “Runtime Guarantees” 2023-01-09 14:27:13 +01:00
Martin Geisler
ba3c6b0de9 Speaker notes for “Modern Features” 2023-01-09 14:27:13 +01:00
Martin Geisler
cf505e99cd Rephrase “No memory leaks”
The footnote was added before we had support for speaker notes. It’s
too large to show on the screen during a classroom presentation, so it
has now been moved to the speaker notes.

I tried to keep the information intact, including keeping the word
“mostly” on the slide.
2023-01-09 14:26:47 +01:00
Martin Geisler
a7adf49002 Speaker notes for “Why Rust?” 2023-01-09 14:26:47 +01:00
Martin Geisler
50b0ad76eb Introduce speaker notes on welcome page 2023-01-09 14:24:02 +01:00
Andrew Walbran
49b4fff348
Merge pull request #131 from fbornhofen/main
Add speaker notes to copy-clone.md
2023-01-09 13:05:02 +00:00
Fabian Bornhofen
0723135dc6 Remove bullet point about printing p1 2023-01-09 13:39:39 +01:00
Fabian Bornhofen
45bc1233d2 s/twice/again/ 2023-01-09 13:37:06 +01:00
Fabian Bornhofen
e213f9dbd3 Add speaker notes to copy-clone.md 2023-01-09 13:20:00 +01:00
Andrew Walbran
ba275812aa
Merge pull request #129 from hezhizhen/patch-1
Fix typo in `structure.md`
2023-01-09 10:14:57 +00:00
Zhizhen He
b287aeada1
Fix typo in structure.md 2023-01-09 02:01:28 +08:00
Martin Geisler
7e0670e6b7
Merge pull request #126 from marshallpierce/patch-2
Use rustls instead of openssl
2023-01-07 14:50:18 +01:00
Martin Geisler
ca0f475fad
Merge pull request #127 from imichael2e2/main
Update broken links
2023-01-07 14:49:11 +01:00
Michael Lee
3f4ae0606d Update broken links 2023-01-07 15:38:40 +08:00
Andrew Walbran
d3605aaaee
Merge pull request #125 from google/dependabot/cargo/tokio-1.24.1
Bump tokio from 1.23.0 to 1.24.1
2023-01-06 22:26:43 +00:00
Marshall Pierce
b67908698f Use rustls instead of openssl
Using the `rustls-tls` feature on reqwest will use rustls and ring, which should compile on any system.
2023-01-06 15:22:40 -07:00
dependabot[bot]
0b7357a32d
Bump tokio from 1.23.0 to 1.24.1
Bumps [tokio](https://github.com/tokio-rs/tokio) from 1.23.0 to 1.24.1.
- [Release notes](https://github.com/tokio-rs/tokio/releases)
- [Commits](https://github.com/tokio-rs/tokio/compare/tokio-1.23.0...tokio-1.24.1)

---
updated-dependencies:
- dependency-name: tokio
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-01-06 22:02:55 +00:00
Ilya Grigoriev
68eed5b4f2
Error handling: clarify printing of Result
Two examples may print either `Ok(username)` or `Err(error)`.
This commit clarifies this fact.
2023-01-06 12:35:05 -08:00
Martin Geisler
e074b8c87f
Merge pull request #122 from marshallpierce/patch-1
Create an empty Vec rather than pre-allocating
2023-01-06 17:51:56 +01:00
Marshall Pierce
0a9dd33e58
Create an empty rather than pre-allocating
It might give the impression that you can only write to a Vec that has capacity, when in fact Vec's Write impl will grow the storage as needed. While pre-allocating is probably a good efficiency win in many circumstances, I think it's probably worth minimizing the number of concepts in play in this example.
2023-01-06 09:47:42 -07:00
鐘天楽
c8f626e573
for-loop bonus explanation (#108)
* for-loop bonus explanation
2023-01-06 10:15:16 +01:00
Martin Geisler
9a68434cac
Merge pull request #49 from ilyagr/patch-1
`anyhow`: Remove `ReadUsernameError::IoError`
2023-01-05 15:57:17 +01:00
Martin Geisler
6e8942ef12
Merge pull request #112 from google/speaker-notes-closed
Show speaker notes as closed by default
2023-01-05 10:48:09 +01:00
Martin Geisler
59e4a912ca
Merge pull request #113 from google/no-speaker-notes-on-mobile
Hide speaker note popup link on mobile
2023-01-05 10:08:15 +01:00
Andrew Walbran
34f28cd4a0
Merge pull request #114 from yesenarman/patch-2
Fix a typo in `result.md`
2023-01-05 08:47:44 +00:00
Arman Yessenamanov
e1c670c4a8
Fix a typo in result.md
"have already see" -> "have already seen"
2023-01-05 14:41:40 +06:00
Martin Geisler
8feb6b4ad4
Merge pull request #109 from rhapsodyai/fixes-99
Fixes: #99
2023-01-05 09:08:03 +01:00
Martin Geisler
019e464ba8 Hide speaker note popup link on mobile
This uses the same media query as the rest of the mdbook theme:
devices with a width less than 1080px (mobiles) will not see the link
to open speaker notes in a new window.
2023-01-05 08:27:19 +01:00
Martin Geisler
986d607d1e Show speaker notes as closed by default
This makes it clearer that the notes are extra content.
2023-01-05 08:06:09 +01:00
Martin Geisler
15f88b3700
Merge pull request #107 from google/speaker-notes
Add support for speaker notes
2023-01-05 07:48:01 +01:00
Martin Geisler
d5359fa92a Add support for speaker notes
This implements a system for speaker notes via `details` elements and
some JavaScript. The general idea is

1. You add speaker notes to each page by wrapping some Markdown code
   in `<details> … </details>`. This is a standard HTML element for,
   well extra details. Browsers will render the element with a toggle
   control for showing/hiding the content.

2. We inject JavaScript on every page which finds these speaker note
   elements. They’re styled slightly and we keep their open/closed
   state in a browser local storage. This ensures that you can keep
   them open/closed across page loads.

3. We add a link to the speaker notes which will open in a new tab.
   The URL is amended with `#speaker-notes-open`, which we detect in
   the new tab: we hide the other content in this case.
   Simultaneously, we hide the speaker notes in the original window.

4. When navigating to a new page, we signal this to the other window.
   We then navigate to the same page. The logic above kicks in and
   hides the right part of the content. This lets the users page
   through the course using either the regular window or the speaker
   notes — the result is the same and both windows stay in sync.

Tested in both Chrome and Firefox. When using a popup speaker note
window, the content loads more smoothly in Chrome, but it still works
fine in Firefox.

Fixes #53.
2023-01-05 07:46:18 +01:00
Melissa Auclaire
115c87d8fd Fixes: #99 2023-01-04 17:55:28 -08:00
Andrew Walbran
28942d7b9f
Merge pull request #36 from daym/patch-1
Tuples with "..." make no sense, so don't use them
2023-01-04 15:42:35 +00:00
Andrew Walbran
9f46beafdb
Merge pull request #105 from Adrian-Samoticha/patch-1
Fix typo in `modules.md`
2023-01-04 15:42:07 +00:00
Andrew Walbran
1fb87d4b81
Merge pull request #106 from Adrian-Samoticha/patch-2
Fix typo in `visibility.md`
2023-01-04 15:41:59 +00:00
Adrian Samoticha
a0ad1eafa8
Fix typo in visibility.md 2023-01-04 15:58:34 +01:00
Adrian Samoticha
89ad1f6a65
Fix typo in modules.md 2023-01-04 15:44:37 +01:00
Martin Geisler
c2c11531a5
Merge pull request #96 from zhouwfang/simplify-solution-to-prefix-matching
Simplify the solution to prefix matching
2023-01-04 09:11:58 +01:00
Martin Geisler
bffd70a90e
Merge pull request #104 from liao02x/patch-1
fix typo in deriving-error-enums.md
2023-01-04 09:10:18 +01:00