You've already forked comprehensive-rust
mirror of
https://github.com/google/comprehensive-rust.git
synced 2025-07-03 05:27:04 +02:00
Format all Markdown files with dprint
(#1157)
This is the result of running `dprint fmt` after removing `src/` from the list of excluded directories. This also reformats the Rust code: we might want to tweak this a bit in the future since some of the changes removes the hand-formatting. Of course, this formatting can be seen as a mis-feature, so maybe this is good overall. Thanks to mdbook-i18n-helpers 0.2, the POT file is nearly unchanged after this, meaning that all existing translations remain valid! A few messages were changed because of stray whitespace characters: msgid "" "Slices always borrow from another object. In this example, `a` has to remain " -"'alive' (in scope) for at least as long as our slice. " +"'alive' (in scope) for at least as long as our slice." msgstr "" The formatting is enforced in CI and we will have to see how annoying this is in practice for the many contributors. If it becomes annoying, we should look into fixing dprint/check#11 so that `dprint` can annotate the lines that need fixing directly, then I think we can consider more strict formatting checks. I added more customization to `rustfmt.toml`. This is to better emulate the dense style used in the course: - `max_width = 85` allows lines to take up the full width available in our code blocks (when taking margins and the line numbers into account). - `wrap_comments = true` ensures that we don't show very long comments in the code examples. I edited some comments to shorten them and avoid unnecessary line breaks — please trim other unnecessarily long comments when you see them! Remember we're writing code for slides 😄 - `use_small_heuristics = "Max"` allows for things like struct literals and if-statements to take up the full line width configured above. The formatting settings apply to all our Rust code right now — I think we could improve this with https://github.com/dprint/dprint/issues/711 which lets us add per-directory `dprint` configuration files. However, the `inherit: true` setting is not yet implemented (as far as I can tell), so a nested configuration file will have to copy most or all of the top-level file.
This commit is contained in:
dprint.json
mdbook-course/src
mdbook-exerciser/src
po
rustfmt.tomlsrc
SUMMARY.mdandroid.mdalloc.mdandroid.md
android
aidl.mdsetup.md
async.mdaidl
build-rules.mdbuild-rules
interoperability.mdinteroperability
cpp
android-build-cpp.mdandroid-cpp-genrules.mdbridge.mdcpp-bridge.mdcpp-exception.mdrust-bridge.mdrust-result.mdshared-enums.mdshared-types.mdtype-mapping.md
java.mdwith-c.mdwith-c
async
bare-metal.mdbare-metal
alloc-example
src
android
aps.mdaps
better-uart.md
microcontrollers.mdbetter-uart
entry-point.mdexamples
exceptions.mdinline-assembly.mdlogging.mdlogging
mmio.mdother-projects.mduart.mduart
microcontrollers
board-support.mddebugging.mdembedded-hal.mdhals.mdmmio.mdother-projects.mdpacs.mdprobe-rs.mdtype-state.md
minimal.mdno_std.mduseful-crates.mdexamples
src
useful-crates
borrowing
cargo.mdcargo
chromium.mdchromium
adding-third-party-crates.md
concurrency.mdadding-third-party-crates
checking-in.mdconfiguring-cargo-toml.mdconfiguring-gnrt-config-toml.mddepending-on-a-crate.mddownloading-crates.mdgenerating-gn-build-rules.mdkeeping-up-to-date.mdresolving-problems.md
build-rules.mdresolving-problems
reviews-and-audits.mdbuild-rules
cargo.mdinteroperability-with-cpp.mdinteroperability-with-cpp
error-handling-png.mderror-handling-qr.mderror-handling.mdexample-bindings.mdlimitations-of-cxx.mdusing-cxx-in-chromium.md
policy.mdsetup.mdtesting.mdtesting
concurrency
control-flow-basics
credits.mderror-handling
exercises
android
bare-metal
chromium
bringing-it-together.mdbuild-rules.mdinteroperability-with-cpp.mdsolutions.mdtesting.mdthird-party.md
concurrency
generics
glossary.mdhello-world
index.mditerators
memory-management
methods-and-traits
modules
other-resources.mdpattern-matching
references
running-the-course.mdrunning-the-course
slices-and-lifetimes
exercise.mdexercise.rslifetime-annotations.mdlifetime-elision.mdslices.mdsolution.mdstr.mdstruct-lifetimes.md
smart-pointers
std-traits
std-types
testing
thanks.mdtuples-and-arrays
types-and-values
unsafe-rust
dereferencing.mdexercise.mdexercise.rsmutable-static.mdunions.mdunsafe-functions.mdunsafe-traits.mdunsafe.md
user-defined-types
welcome-day-1.mdwelcome-day-2.mdwelcome-day-3.mdwelcome-day-4.md@ -23,11 +23,7 @@ pub fn insert_timing_info(slide: &Slide, chapter: &mut Chapter) {
|
||||
{
|
||||
// Include the minutes in the speaker notes.
|
||||
let minutes = slide.minutes;
|
||||
let plural = if slide.minutes == 1 {
|
||||
"minute"
|
||||
} else {
|
||||
"minutes"
|
||||
};
|
||||
let plural = if slide.minutes == 1 { "minute" } else { "minutes" };
|
||||
let mut subslides = "";
|
||||
if slide.source_paths.len() > 1 {
|
||||
subslides = "and its sub-slides ";
|
||||
|
Reference in New Issue
Block a user