-
Notifications
You must be signed in to change notification settings - Fork 25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
setup xtask infra for cheatsheets #159
Conversation
Deploying ferrous-systems-rust-training with Cloudflare Pages
|
Could we add a few words (here, or in a README) about how the cheatsheets work - to save having to read and understand the source code? |
Also, it needs a rebase on |
e33892a
to
ddd8c18
Compare
|
@jonathanpallant this feels ready for review again. |
- Functions that return a Result shouldn't unwrap/expect - use the eyre crate to add context, seeing as we have it included - Talk about 'decks' and not 'slides' (a 'deck' has many 'slides' in it) - Format doc comments correctly - Add missing function comments
I elected to push some changes rather than leave a bunch of review comments. Please do review the diff and let me know if you have any questions. The final matter is deciding how we want CI to run this, to automatically check out cheatsheets. Ideally we'd have a |
All the comments being hoisted to a README make sense to me and the added level of doc comments is welcome, thanks! I'm in favor of writing a |
suggestion has been committed
Resolved a small merge conflict by accepting the |
Ah, I noticed there's a corner case I haven't handled, I'm going to work on it for a bit. Removing the review request for now. |
Problem:
Making cheatsheets like "From Python to Rust" and friends is going to be a maintainability nightmare as
training-materials
grows, changes ownership, etc., over time. This was raised as a concern in #148 and this PR seeks to fix that.Proposed solution:
Setup a
xtask
style workflow where wecargo xtask make-cheatsheet python
at the root folderSUMMARY..md
and segment topics byRust Fundamentals
,Applied Rust
andAdvanced Rust
src/python-cheatsheet.md
if it doesn't existpython-cheatsheet.md
are in the appropriate sections, in order, and none are missing.The code is (I think) defensive to spare future pain for someone else looking at this code
(myself in a few months).This PR only sets up the infrastructure but doesn't add any cheatsheets themselves - I'll file a separate PR with a basic Julia cheatsheet once this lands to separate concerns.
Current functionality: