1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-12-04 19:45:19 +02:00
Commit Graph

343 Commits

Author SHA1 Message Date
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
liao02x
8d36a3bdd3
fix typo in deriving-error-enums.md 2023-01-03 21:18:30 -08:00
Zhou Fang
1fb0b0a46d Simplify solution to prefix matching. 2023-01-03 20:11:20 -08:00
Martin Geisler
eee3fb6302
Merge pull request #101 from google/course-target-audience
Explain who the course is for
2023-01-03 18:10:09 +01:00
Martin Geisler
571c87283d Explain how the course can be used
From a discussion on Twitter:
https://twitter.com/bluxte/status/1610297443324727298.
2023-01-03 16:55:33 +01:00
Martin Geisler
78766a6bf6
Merge pull request #98 from google/simplify-publish
Simplify the publish workflow
2023-01-03 15:57:50 +01:00
Martin Geisler
499657c830 Simplify the publish workflow
This removes a bunch of boiler-plate comments which were left from the
template I used originally.

It also simplifies the name to just “Publish” since I feel this fits
better for what we do here.
2023-01-03 15:49:21 +01:00
Martin Geisler
9d41acf22d
Merge pull request #97 from google/cargo-test
Run `cargo test` on pull requests
2023-01-03 15:47:48 +01:00
Martin Geisler
a0a1398b9b Simplify workflow name
Now that we multiple jobs, this will look better in the GitHut output:
“Build / mdbook (pull_request)” and “Test / mdbook (pull_request)”.
2023-01-03 14:46:25 +01:00
Martin Geisler
6f49dcf2fe Add Cargo.lock
This captures a set of known-good dependencies for the provided
solutions.
2023-01-03 14:42:33 +01:00
Martin Geisler
1bfe3cf7a2 Run cargo test on pull requests
This uses the `Cargo.toml` file in the repository to test the provided
solutions.
2023-01-03 14:39:24 +01:00
Martin Geisler
2a92487bbd
Merge pull request #94 from MaschitaG/patch-2
Unsafe Rust
2023-01-02 10:32:00 +01:00
Martin Geisler
b027db0241
Add back links to the Rust Book
I think it's important that we link the students to the full information about Unsafe Rust.
2023-01-02 10:30:40 +01:00
MaschitaG
b2ae19b5fd
Update static-and-const.md 2023-01-02 10:25:39 +01:00
MaschitaG
1c1c3d38d8
Unsafe Rust
Unsafe Rust is mentioned in the course
2023-01-02 10:12:56 +01:00
Martin Geisler
12c110d172
Merge pull request #93 from Fosco1/patch-1
Corrected typo on receiver.md
2023-01-02 10:08:42 +01:00
Martin Geisler
9499ddb8f9
Merge pull request #92 from MaschitaG/patch-1
Update welcome.md
2023-01-02 10:06:46 +01:00
Fosco1
a4bd084e50
Corrected typo on receiver.md
https://dictionary.cambridge.org/it/grammatica/grammatica-britannico/it-s-or-its
2023-01-02 10:04:04 +01:00
MaschitaG
a7461f805a
Update welcome.md
Make the language more precise
2023-01-02 10:01:10 +01:00
Martin Geisler
a62c695fe3
Merge pull request #91 from sudonym1/patch-1
Correct compilation error in unit-tests.md
2023-01-02 09:04:41 +01:00
Seamus Connor
6cb3254cf1
Correct compilation error in unit-tests.md 2023-01-01 13:57:19 -08:00
Martin Geisler
51cbf29d92
Merge pull request #79 from riking/patch-1
comparison: copyedit 'delays' to 'delayed'
2022-12-31 12:35:24 +01:00
Martin Geisler
150e78a3f9
Rephrase destructor delays
After a discussion, it seems singular works well.
2022-12-31 12:33:57 +01:00
Martin Geisler
8a8f44b568
Merge pull request #89 from jswalden/patch-3
Typo in "Fearless Concurrency" intro
2022-12-31 12:27:00 +01:00
Martin Geisler
ce143ad031
Merge pull request #90 from jswalden/patch-4
Typo in concurrency exercises intro
2022-12-31 12:26:20 +01:00
Jeff Walden
1ae03443d5
"a classic problem", not "...problems" 2022-12-30 21:54:35 -08:00
Jeff Walden
9def3e371d
Typo in "Fearless Concurrency" intro
"referred to a _fearless concurrency_" -> "referred to a*s* _fearless concurrency_"
2022-12-30 20:53:38 -08:00
Martin Geisler
d8fd38b88a
Merge pull request #81 from google/utf-8-encoding
Mention that strings are UTF-8 encoded
2022-12-28 20:38:46 +01:00
Martin Geisler
d7a33f24a6
Merge pull request #83 from google/mention-arc
Mention `Arc` on `Rc` slide
2022-12-28 20:38:22 +01:00
Martin Geisler
4a0455f5bd
Merge pull request #85 from der3318/update-test-cases-for-polygons
Better Test Case for Day 2 Polygon Exercise
2022-12-28 15:46:15 +01:00
Martin Geisler
6851a6b533
Show different tuple sizes 2022-12-28 15:41:08 +01:00
Der Chien
0b77fc6bf3
20221228 revert the points length check 2022-12-28 22:39:52 +08:00
Martin Geisler
7b98da490a
Merge pull request #84 from yesenarman/patch-1
Fix a typo: "will be drop" -> "will be dropped"
2022-12-28 15:31:18 +01:00
Der Chien
42494f95ab
20221228 add one more point to the polygon 2022-12-28 21:49:01 +08:00
Arman Yessenamanov
8470be86d0
Fix a typo 2022-12-28 18:58:23 +06:00
Martin Geisler
7ee63aced6
Mention Arc on Rc slide
Fixes #67.
2022-12-28 10:15:17 +01:00
Martin Geisler
cac0641a54
Mention that strings are UTF-8 encoded
Technically, it's the Rust source file that is UTF-8 encoded, but in practical terms, this means that the string literals are UTF-8 encoded. It's only if you start using non-ASCII identifiers that you end up with UTF-8 encoded text outside of a string literal.

Fixes #35.
2022-12-28 09:32:28 +01:00
Martin Geisler
dcf29d4653
Merge pull request #74 from google/try-operator
More precise phrasing of what ? expands to
2022-12-28 09:26:18 +01:00
Martin Geisler
2a73a58e25
Merge pull request #75 from google/method-receiver-types
Mention that there are other receiver types
2022-12-28 09:23:52 +01:00
Martin Geisler
94cd8bb592
Link to reference on method receiver types 2022-12-28 09:19:19 +01:00
Kane York
de7d91752f
comparison: copyedit 'delays' to 'delayed'
This is the correct grammatical form for the bullet point, it expands into "Destructors [of objects are] delayed."
2022-12-27 14:13:10 -08:00