Add Rust concept notes to Burn Book #1169
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1169 /- ##
==========================================
- Coverage 86.00% 85.97% -0.04%
==========================================
Files 522 522
Lines 58783 59179 396
==========================================
Hits 50558 50879 321
- Misses 8225 8300 75 ☔ View full report in Codecov by Sentry. |
| <details id="derive-attribute"> | ||
| <summary><strong>🦀 Derive Attribute</strong></summary> | ||
|
|
||
| The `derive` attribute allows traits to be implemented easily by generating code that will |
There was a problem hiding this comment.
Not only for traits, you can add arbitrary code based on the provided type, but you can't modify the existing code; you can only append new elements. Using the attribute #[my_macro], you can effectively update the provided code. Derive is frequently employed to recursively implement traits, where the implementation consists of the composition of all fields.
| In Rust, memory management is rather unique. Aside from | ||
| [primitive types](https://doc.rust-lang.org/rust-by-example/primitives.html), every value is _owned_ |
There was a problem hiding this comment.
I think this is related to the Copy trait, not necessarily the primitive types (although they all implement Copy, making it a great example).
|
@nathanielsimard made the requested changes! Let me know if my additions are correct :) |
Checklist
run-checks allscript has been executed.Related Issues/PRs
Closes #1155
Changes
For new Rustaceans, following the guide should be enough to get started with Burn. In the previous version of the book, we simply mentioned that people should "read the first chapters of the Rust Book" first.
While it is still recommended, this PR introduces 🦀 Rust Note indicators throughout the sections 3 (Getting Started) and 4 (Basic Workflow, aka "The Guide").
The notes are collapsible sections which provide explanations for the basic Rust concepts involved in the current context.
🦀 An Example Note
This note should briefly explain one concept (or in some cases, a few related concepts) particular to Rust and perhaps detail how it is applied in the current section.
External references are usually provided, pointing to the Rust Book as the main source.
Let me know what you think about the context notes as collapsible sections! I used the crab 🦀 emoji since the notes are supposed to be Rust specific, but it could be changed if you have any other preferences.
Also, any comments on the added notes are welcome! And if you think I missed anything let me know.