Merge #342

342: Spell check r=AfoHT a=regexident



Co-authored-by: Vincent Esche <regexident@gmail.com>

Cargo.toml

@@ -5,7 +5,7 @@ authors = [
   "Per Lindgren <per.lindgren@ltu.se>",
 ]
 categories = ["concurrency", "embedded", "no-std"]
-description = "Real-Time Interrupt-driven Concurrency (RTIC): a concurrency framework for building real time systems"
+description = "Real-Time Interrupt-driven Concurrency (RTIC): a concurrency framework for building real-time systems"
 documentation = "https://rtic.rs/"
 edition = "2018"
 keywords = ["arm", "cortex-m"]

README.md

@@ -1,6 +1,6 @@
 # Real-Time Interrupt-driven Concurrency
 
-A concurrency framework for building real time systems.
+A concurrency framework for building real-time systems.
 
 Formerly known as Real-Time For the Masses.
 

book/en/src/SUMMARY.md

@@ -1,6 +1,7 @@
 # Summary
 
 [Preface](./preface.md)
+
 - [RTIC by example](./by-example.md)
   - [The `app` attribute](./by-example/app.md)
   - [Resources](./by-example/resources.md)

book/en/src/by-example/app.md

@@ -90,7 +90,7 @@ $ cargo run --example idle
 To declare interrupt handlers the framework provides a `#[task]` attribute that
 can be attached to functions. This attribute takes a `binds` argument whose
 value is the name of the interrupt to which the handler will be bound to; the
-function adornated with this attribute becomes the interrupt handler. Within the
+function adorned with this attribute becomes the interrupt handler. Within the
 framework these type of tasks are referred to as *hardware* tasks, because they
 start executing in reaction to a hardware event.
 

book/en/src/by-example/tasks.md

@@ -78,7 +78,7 @@ message. In most scenarios spawning errors are handled in one of two ways:
   platform can deal with peak payload or if the processor needs to be replaced
   with a faster one.
 
-- Ignoring the result. In soft real time and non real time applications it may
+- Ignoring the result. In soft real-time and non real-time applications it may
   be OK to occasionally lose data or fail to respond to some events during event
   bursts. In those scenarios silently letting a `spawn` call fail may be
   acceptable.

book/en/src/by-example/tips.md

@@ -155,7 +155,7 @@ const APP: () = {
 };
 ```
 
-Or, you can use the [`cargo-expand`] subcommand. This subcommand will expand
+Or, you can use the [`cargo-expand`] sub-command. This sub-command will expand
 *all* the macros, including the `#[rtic::app]` attribute, and modules in your
 crate and print the output to the console.
 
@@ -169,7 +169,7 @@ $ cargo expand --example smallest | tail
 ## Resource de-structure-ing
 
 When having a task taking multiple resources it can help in readability to split
-up the resource struct. Here're two examples on how this can be done:
+up the resource struct. Here are two examples on how this can be done:
 
 ``` rust
 {{#include ../../../../examples/destructure.rs}}

book/en/src/preface.md

@@ -1,6 +1,6 @@
 <h1 align="center">Real-Time Interrupt-driven Concurrency</h1>
 
-<p align="center">A concurrency framework for building real time systems</p>
+<p align="center">A concurrency framework for building real-time systems</p>
 
 # Preface