rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-06-07 10:06:22 +02:00
Code Issues Releases Activity

Format the glossary using a Markdown list (#1307)

Browse Source 
This format has two advantages:

- is easier to maintain in the Markdown file. Tables cannot be wrapped
in Markdown, which would severely limit what we can write for each term.
- it can be styled better. The layout now looks more like what you find
in a dictionary.

Before:


![image](https://github.com/google/comprehensive-rust/assets/89623/26bdc39e-4c1d-4f33-90d5-a1637712bcb8)

After:


![image](https://github.com/google/comprehensive-rust/assets/89623/38c1b329-4a80-4771-b415-425a537a0388)


Followup to #1277.
This commit is contained in:
Martin Geisler 2023-10-06 14:26:52 +02:00 committed by GitHub
parent 8ff97f1ee7
commit a7f7afa4a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 97 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

166
src/glossary.md
View File

@ -4,73 +4,101 @@ The following is a glossary which aims to give a short definition of many Rust
terms. For translations, this also serves to connect the term back to the terms. For translations, this also serves to connect the term back to the
English original. English original.
<!-- Translators: please list the English term in italic after your translation. <style>
For Danish, this would look like this: `allokere (_allocate_)`. --> h1#glossary ~ ul {
list-style: none;
padding-inline-start: 0;
}
| Term | Notes | h1#glossary ~ ul > li {
| --------------------- | ---------------------------------------------------------------------------- | /* Simplify with "text-indent: 2em hanging" when supported:
| allocate | Dynamic memory allocation on [the heap](memory-management/stack-vs-heap.md). | https://caniuse.com/mdn-css_properties_text-indent_hanging */
| argument | | padding-left: 2em;
| Bare-metal Rust | See [Bare-metal Rust](bare-metal.md). | text-indent: -2em;
| block | See [Blocks](control-flow/blocks.md) and _scope_. | }
| borrow | See [Borrowing](ownership/borrowing.md). |
| borrow checker | The part of the Rust compiler which checks that all borrows are valid. | h1#glossary ~ ul > li:first-line {
| brace | `{` and `}`. Also called _curly brace_, they delimit _blocks_. | font-weight: bold;
| build | | }
| call | | </style>
| channel | Used to safely pass messages [between threads](concurrency/channels.md). |
| Comprehensive Rust 🦀 | The courses here are jointly called Comprehensive Rust 🦀. | <!--
| concurrency | | Translators: please add the English term in italic after your translated term.
| Concurrency in Rust | See [Concurrency in Rust](concurrency.md). | Also, please keep the hard line breaks to ensure a nice formatting.
| constant | | -->
| control flow | |
| crash | | - allocate:\
| enumeration | | Dynamic memory allocation on [the heap](memory-management/stack-vs-heap.md).
| error | | - argument:\
| error handling | | - Bare-metal Rust: See [Bare-metal Rust](bare-metal.md).
| exercise | | - block:\
| function | | See [Blocks](control-flow/blocks.md) and _scope_.
| garbage collector | | - borrow:\
| generics | | See [Borrowing](ownership/borrowing.md).
| immutable | | - borrow checker:\
| integration test | | The part of the Rust compiler which checks that all borrows are valid.
| keyword | | - brace:\
| library | | `{` and `}`. Also called _curly brace_, they delimit _blocks_.
| macro | | - build:\
| main function | | - call:\
| match | | - channel:\
| memory leak | | Used to safely pass messages [between threads](concurrency/channels.md).
| method | | - Comprehensive Rust 🦀:\
| module | | The courses here are jointly called Comprehensive Rust 🦀.
| move | | - concurrency:\
| mutable | | - Concurrency in Rust:\
| ownership | | See [Concurrency in Rust](concurrency.md).
| panic | | - constant:\
| parameter | | - control flow:\
| pattern | | - crash:\
| payload | | - enumeration:\
| program | | - error:\
| programming language | | - error handling:\
| receiver | | - exercise:\
| reference counting | | - function:\
| return | | - garbage collector:\
| Rust | | - generics:\
| Rust Fundamentals | Days 1 to 3 of this course. | - immutable:\
| Rust in Android | See [Rust in Android](android.md). | - integration test:\
| safe | | - keyword:\
| scope | | - library:\
| standard library | | - macro:\
| static | | - main function:\
| string | | - match:\
| struct | | - memory leak:\
| test | | - method:\
| thread | | - module:\
| thread safety | | - move:\
| trait | | - mutable:\
| type | | - ownership:\
| type inference | | - panic:\
| undefined behavior | | - parameter:\
| union | | - pattern:\
| unit test | | - payload:\
| unsafe | | - program:\
| variable | | - programming language:\
- receiver:\
- reference counting:\
- return:\
- Rust:\
- Rust Fundamentals:\
Days 1 to 3 of this course.
- Rust in Android:\
See [Rust in Android](android.md).
- safe:\
- scope:\
- standard library:\
- static:\
- string:\
- struct:\
- test:\
- thread:\
- thread safety:\
- trait:\
- type:\
- type inference:\
- undefined behavior:\
- union:\
- unit test:\
- unsafe:\
- variable:\