1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-12-21 01:39:07 +02:00
Commit Graph

1676 Commits

Author SHA1 Message Date
Martin Geisler
c509dbd9e4
Always install and run mdbook-pandoc (#1713)
Before, we only installed and ran `mdbook-pandoc` when publishing the
course — which means that a PR change could accidentally break the
publish workflow. We now test that it works on every PR.

From a discussion in #1704.
2024-03-04 16:25:58 +01:00
Martin Geisler
1b3984df20
Move Mockall and GoogleTest slides to Android section (#1533)
After #1528 and #1532, we now have actual slides which showcase the
crates in action. So we can reclaim a few minutes by removing the slide
which mentions Mockall and GoogleTest slide.

The slide mentioned [proptest](https://docs.rs/proptest) and
[rstest](https://docs.rs/rstest) as well. While I'm sure the libraries
are useful, we don't have them imported into AOSP and I've never
personally used them. We should therefore not advertise them yet at this
point since they won't be useful to Android engineers.

Of course we can mention things that are not in AOSP (or in Chromium),
but I think we should do it in the speaker notes at most.
2024-03-04 16:25:35 +01:00
Gergely Risko
c763932288
Small formatting fix (#1866)
This is a typo, that actually @mgeisler stopped in my previous PR, I was
just not around to fix it fast enough to make it to the previous merge.
Thanks for the catch!
2024-03-04 09:46:59 -05:00
Gergely Risko
e74a8b77bd
URGENT: Fix course schedule watcher github action (#1867)
@djmitche Currently all PRs are marked as schedule change PRs.

This is my try to propose a fix for this, but please review diligently,
I'm no github actions expert, and I don't have an environment to test.
2024-03-04 09:39:30 -05:00
dependabot[bot]
9a72b87fa9
cargo: bump the minor group with 2 updates (#1870)
Bumps the minor group with 2 updates:
[scraper](https://github.com/causal-agent/scraper) and
[tokio-websockets](https://github.com/Gelbpunkt/tokio-websockets).

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-03-04 11:37:43 +00:00
dependabot[bot]
e2c38d106e
cargo: bump the patch group in /src/exercises/bare-metal/rtc with 1 update (#1874)
Bumps the patch group in /src/exercises/bare-metal/rtc with 1 update:
[log](https://github.com/rust-lang/log).

Updates `log` from 0.4.20 to 0.4.21

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-03-04 11:00:43 +00:00
dependabot[bot]
1e6fa1cb49
cargo: bump the patch group with 4 updates (#1873)
Bumps the patch group with 4 updates:
[log](https://github.com/rust-lang/log),
[tempfile](https://github.com/Stebalien/tempfile),
[cxx](https://github.com/dtolnay/cxx) and
[cxx-build](https://github.com/dtolnay/cxx).

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-03-04 10:55:27 +00:00
dependabot[bot]
2bed943920
build(deps): bump crate-ci/typos from 1.18.2 to 1.19.0 (#1872)
Bumps [crate-ci/typos](https://github.com/crate-ci/typos) from 1.18.2 to
1.19.0.

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-03-04 10:54:38 +00:00
dependabot[bot]
64e3a88d80
cargo: bump the patch group in /src/bare-metal/aps/examples with 1 update (#1871)
Bumps the patch group in /src/bare-metal/aps/examples with 1 update:
[log](https://github.com/rust-lang/log).

Updates `log` from 0.4.20 to 0.4.21

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-03-04 10:54:04 +00:00
Dustin J. Mitchell
adff70d025
Update course-schedule PR comments in-place (#1856)
Instead of always adding a new comment, just update the existing comment
if one exists.

This fixes #1834.
2024-02-29 10:51:37 -05:00
Nicole L
c1e605df25
Rework introduction of pattern matching (#1843) 2024-02-28 11:14:53 -08:00
Martin Geisler
9b57c48615
Sort mdbook redirects (#1761)
There were a few comments, but I think it’s better to make it all
uniform and avoid these comments. The comment was about the v2 rewrite,
but this is now done and so the comment is less useful.

I also normalized the quotes to double-quotes instead of single-quotes.
The latter is a literal string in TOML, but we don’t actually have any
special characters to escape here.
2024-02-27 17:20:41 +00:00
Martin Geisler
dc4a1eb53b
Skip translation of large bare-metal code blocks (#1853)
This was done a bit inconsistently before. We now skip all of these
large blocks which are meant to be used as-is by the students.

This removes 700 lines from the PO files. I found this during the review
of #1651.
2024-02-27 16:53:05 +01:00
Max Heller
3e7ce5e6ee
Link to PDF version of course from first page (#1836)
Re
https://github.com/google/comprehensive-rust/pull/1805#pullrequestreview-1888804528

---------

Co-authored-by: Martin Geisler <martin@geisler.net>
2024-02-26 13:24:28 +01:00
Andriy Redko
926a5c6fd0
uk: Day 3: afternoon (#1849)
uk: Day 3: afternoon

Signed-off-by: Andriy Redko <drreta@gmail.com>
2024-02-26 12:01:00 +00:00
dependabot[bot]
afe9814ef0
cargo: bump the patch group in /src/exercises/bare-metal/rtc with 1 update (#1852)
Bumps the patch group in /src/exercises/bare-metal/rtc with 1 update:
[cc](https://github.com/rust-lang/cc-rs).

Updates `cc` from 1.0.83 to 1.0.88

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-02-26 10:51:48 +00:00
dependabot[bot]
a5d86d36df
cargo: bump the patch group in /src/bare-metal/aps/examples with 1 update (#1851)
Bumps the patch group in /src/bare-metal/aps/examples with 1 update:
[cc](https://github.com/rust-lang/cc-rs).

Updates `cc` from 1.0.83 to 1.0.88

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-02-26 10:51:06 +00:00
dependabot[bot]
cbcf599588
cargo: bump the patch group with 6 updates (#1850)
Bumps the patch group with 6 updates

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-02-26 10:50:09 +00:00
Adrian Taylor
3afdabf391
Update cargo.md to fix typos (#1848) 2024-02-23 11:18:04 -08:00
Nicole L
5ecdddf9c8
Remove tangential text from if slide (#1840) 2024-02-23 08:53:26 -08:00
Martin Geisler
099ca497f2
Fix typo in cargo.md (#1847) 2024-02-23 14:15:58 +00:00
Henri F
847e1a038e
Fix definition of Rust Fundamentals in glossary.md (#1844)
Small nitpick: Days 1 to **4** are Rust Fundamentals
2024-02-23 10:06:44 +01:00
Henri F
6a7fd259a3
pt-BR: Merge CR v.2 pt-BR translation back into main (#1846)
This PR merges the pt-BR v.2 translation back to main.
Also, it refreshes the .po file format removing the line numbers.
This requires just a syntactical review, as the partial PRs into this
branch were reviewed already.

You can skim this PR with the [GitHub CLI](https://cli.github.com/):

gh pr diff 1846 | bat -l patch

#317 #1463

---------

Co-authored-by: João Victor Mendes <mendesjoaovic@gmail.com>
Co-authored-by: azevedoalice <158203674+azevedoalice@users.noreply.github.com>
2024-02-23 09:56:53 +01:00
Nicole L
d75dd5d681
Flesh out for loop example (#1841)
* Add example of iterating over a collection.
* Update speaker notes to call out the use of iterators.

I think it's useful to call out that `for` loops primarily are used to
iterate over a collection of objects, even though we haven't yet talked
about any concrete collection types at this point. I think using the
array literal syntax is simple enough to understand that it should be
quick to explain when we get to this slide.
2024-02-22 10:49:49 -05:00
Nicole L
9023dd9caa
Tweak timings of exercises to better reflect teaching times (#1839)
A few of the early exercises had much larger estimates than were
actually necessary for the super simple early exercises. I've gone
through and reviewed the time estimates for exercises and tweaked the
estimates based on how much time students have actually needed in my
classes so far.
2024-02-22 10:21:39 -05:00
Martin Geisler
8670d2f9d9
Add translation comment to glossary (#1831)
With https://github.com/google/mdbook-i18n-helpers/pull/107 merged, we
can begin adding comments for the translators to our Markdown files.
2024-02-22 15:10:01 +01:00
Nicole L
e7076af00f
Move hello world example to second section (#1838)
The current location for the hello world example is awkward since the
two surrounding pages are both talking about Rust from a high level
without talking about syntax at all. I think starting the second section
(types and values) with the hello world example would help the first
section flow more smoothly.
2024-02-21 16:54:11 -05:00
Michael Graf
7fb4ad9ed2
Update user-defined-types/exercise.md (#1835)
Allow us to edit so we can complete the exercise :)
2024-02-20 22:08:39 +00:00
Jean Carlo Vicelli
c6ef83e512
Update exercise to add also the tests, in a TDD style (#1832)
Having the tests only in the result brings less value, so the
participants can do it following TDD practices
2024-02-20 17:04:53 -05:00
Dustin J. Mitchell
95fce416ce
Expand Traits, add associated types (#1815)
This breaks the "Traits" slide into three smaller sub-slides. It also
addresses part of #1511 by explicitly addressing associated types.

---------

Co-authored-by: Martin Geisler <martin@geisler.net>
2024-02-20 11:41:53 -05:00
Jean Carlo Vicelli
9d63f23f1d
Change hardcoded vector update to a for loop (#1833)
iterating over the vector instead of hardcoding each item

---------

Co-authored-by: Martin Geisler <mgeisler@google.com>
2024-02-20 17:29:49 +01:00
titong0
8344cbc273
Add missing editable attribute to exercise (#1827)
I was reading the docs and I stumbled upon this.

I'm unsure about when exercises should be solved directly on the site
and when they should be copied and pasted into a playground. But since
the previous chapter's exercise is solvable in the site [(fibonacci
sequence)](0cb7f496b5/src/types-and-values/exercise.md (L15)),

I figured this one might be missing the attribute. Anyway amazing work
on the docs!
2024-02-20 16:12:55 +00:00
Dustin J. Mitchell
152354e9c9
Put a header on schedule comments (#1814)
This will add a little more context. See the current result in
https://github.com/google/comprehensive-rust/pull/1813.
2024-02-20 09:19:14 -05:00
Gergely Risko
d5879d87b2
Reformulate speaker notes regarding Box (#1819)
The first change is to reformulate the English in a way, that
emphasizes, that this is not a decision of the compiler, but the
impossibility of computing an infinite value (e.g. changed the language
from "not compute" to "would not be able to compute").

The second change is to fix the error message, of course the error
message from the compiler is "recursive withOUT indirection", as
"recursive with indirection" is actually what we want.
2024-02-20 09:16:25 -05:00
Henri F
85d2987369
Update translations.md with new Korean contributor (#1823)
Co-authored-by: Martin Geisler <mgeisler@google.com>
2024-02-20 10:50:42 +00:00
AdrienBaudemont
675573f0fa
fr: Updating the first few pages (up to 1.1). (#1778) 2024-02-20 11:42:12 +01:00
Marja Hölttä
f1e4f300ec
Make the "break with label" example more illustrative (#1830)
In the old version, using "break 'outer;" and using "break;" (without
the label) produce the same output.

This version fixes that to make the example more illustrative.

---------

Co-authored-by: Martin Geisler <martin@geisler.net>
2024-02-20 10:06:29 +00:00
Max Heller
8080e2add6
Rendered PDF improvements (#1805)
Updates `mdbook-pandoc` to
[0.5.0](https://github.com/max-heller/mdbook-pandoc/releases/tag/v0.5.0)
to use some new features:
- Table wrapping (closes #1709)
  
The wrapping logic mirror's
[Pandoc's](https://pandoc.org/MANUAL.html#extension-pipe_tables) (i.e.,
compare the relative widths of the `---` columns to determine column
widths) so tables in the source may need tweaking to get the proportions
right
- Replace broken links in PDF with corresponding links to
https://google.github.io/comprehensive-rust/
2024-02-20 11:04:30 +01:00
mobyw
6b805230c7
Add heading attribute to glossary.md (#1829)
Add heading attributes[1] to avoid ID changes in translation.

[1]: https://rust-lang.github.io/mdBook/format/markdown.html#heading-attributes

Related: #1825

---------

Co-authored-by: Martin Geisler <martin@geisler.net>
2024-02-20 10:00:59 +00:00
mobyw
f600b9629b
Fix style in glossary.md (#1825)
`id` of `h1` title in the translated version will be changed to the
translated text.
Fixed `id` configured here will not take effect in the translated
version.

Correct style: https://google.github.io/comprehensive-rust/glossary.html
Wrong style (zh-CN): https://google.github.io/comprehensive-rust/zh-CN/glossary.html
2024-02-19 17:17:41 +01:00
Dustin J. Mitchell
22c9555ca8
Suggest --locked for cargo installs (#1792)
This is already used in the GitHub actions, and avoids issues like those
in #1791.

Fixes #1791.
2024-02-19 17:13:46 +01:00
Andriy Redko
18ec2018d1
uk: Day 3: morning (#1826)
Day 3: morning

Signed-off-by: Andriy Redko <drreta@gmail.com>
2024-02-19 11:29:54 +00:00
dependabot[bot]
0cf4ec1352
cargo: bump the patch group with 1 update (#1828)
Bumps the patch group with 1 update:
[clap](https://github.com/clap-rs/clap).

Updates `clap` from 4.5.0 to 4.5.1

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-02-19 11:25:19 +00:00
Diego Romero
0cb7f496b5
Translation correction on Update es.po (#1781)
I added a tranlation correction on the line 1287, I change "tres"
instead "cuatro", because "cuatro" is the meaningful of four in Spanish.

---------

Co-authored-by: Henri F <henrif75@users.noreply.github.com>
2024-02-16 10:41:33 -08:00
Martin Geisler
a95201f027
fa: refresh translation for January 2024 (#1751)
This is a clean refresh, requires only a syntaxtical review.

You can skim this PR with the [GitHub CLI](https://cli.github.com/):

```
gh pr diff 1751 | bat -l patch
```
2024-02-16 10:37:53 -08:00
Martin Geisler
ed79a2044e
da: refresh translation for January 2024 (#1742)
This is a clean refresh, requires only a syntactical review.

You can skim this PR with the [GitHub CLI](https://cli.github.com/):

```
gh pr diff 1742 | bat -l patch
```
2024-02-16 10:37:09 -08:00
Diego Romero
8bbcb3e4b9
Translation correction on Update es.po (#1780)
I added a tranlation correction on the line 1287, I change "tres"
instead "cuatro", because "cuatro" is the meaningful of four in Spanish.

---------

Co-authored-by: Henri F <henrif75@users.noreply.github.com>
2024-02-16 10:29:03 -08:00
Manichand Kondapaka
fccdc0d69a
Added blocks and scopes section (#1822) 2024-02-16 13:12:51 -05:00
mobyw
b5b06b5aa9
zh-CN: index & preparation translation (#1800)
The po file has been refreshed. Translation range: L1173-L2241.

https://github.com/google/comprehensive-rust/issues/324

---------

Co-authored-by: Yihao Wang <42559837+AgainstEntropy@users.noreply.github.com>
2024-02-16 09:40:05 -08:00
Gergely Risko
adaa04f961
Change String representation to actual (#1817)
Tested with rust 2015, 2018, 2021 and 2024, on amd64 musl, amd64 glibc
and aarch64 musl, all of them represent Strings with (ptr, capacity,
len).

This is an internal implementation detail, that shouldn't be exposed
anyway, so it's no big deal, but in the speaker notes, we provide a
debugging tool for demonstration purposes, so at least that should have
a correct output.
2024-02-15 17:24:19 -05:00