aboutsummaryrefslogtreecommitdiff
path: root/book/en/src
diff options
context:
space:
mode:
authorbors[bot] <26634292+bors[bot]@users.noreply.github.com>2020-07-14 15:38:53 +0000
committerGitHub <noreply@github.com>2020-07-14 15:38:53 +0000
commit42f99840c4dc24f9d897c74375191f3972d9f357 (patch)
tree3d007bc87f32cb440171042a69ebab35fe6ee490 /book/en/src
parentbfb498e722dbe68c00ea8aab73d910561bab257c (diff)
parente9fa71c065add03b9aedfb0e848b115370732b3c (diff)
Merge #342
342: Spell check r=AfoHT a=regexident Co-authored-by: Vincent Esche <regexident@gmail.com>
Diffstat (limited to 'book/en/src')
-rw-r--r--book/en/src/SUMMARY.md1
-rw-r--r--book/en/src/by-example/app.md2
-rw-r--r--book/en/src/by-example/tasks.md2
-rw-r--r--book/en/src/by-example/tips.md4
-rw-r--r--book/en/src/preface.md2
5 files changed, 6 insertions, 5 deletions
diff --git a/book/en/src/SUMMARY.md b/book/en/src/SUMMARY.md
index 305c1a0..25aef81 100644
--- a/book/en/src/SUMMARY.md
+++ b/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)
diff --git a/book/en/src/by-example/app.md b/book/en/src/by-example/app.md
index bff516d..e0f4f94 100644
--- a/book/en/src/by-example/app.md
+++ b/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.
diff --git a/book/en/src/by-example/tasks.md b/book/en/src/by-example/tasks.md
index 5978ca8..d0b5acb 100644
--- a/book/en/src/by-example/tasks.md
+++ b/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.
diff --git a/book/en/src/by-example/tips.md b/book/en/src/by-example/tips.md
index ce9bba8..b191b9d 100644
--- a/book/en/src/by-example/tips.md
+++ b/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}}
diff --git a/book/en/src/preface.md b/book/en/src/preface.md
index 6563dd4..419f067 100644
--- a/book/en/src/preface.md
+++ b/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