aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDario Nieuwenhuis <[email protected]>2025-02-11 12:19:32 +0100
committerGitHub <[email protected]>2025-02-11 12:19:32 +0100
commit76fb3a54f38c20f1b16de60da12d21d98bf250fd (patch)
tree960b39f730bed518386ea9c3db17e483939da009
parentf09277b2a37cb77d3adf6675146c282fbcb9c955 (diff)
parent74c42fd9d0522fdd5150b630ea8b7d493964cf31 (diff)
Merge pull request #3869 from owenbrooks/docs_typos
Fix small typos in docs
-rw-r--r--docs/pages/best_practices.adoc2
-rw-r--r--docs/pages/layer_by_layer.adoc2
-rw-r--r--docs/pages/overview.adoc2
3 files changed, 3 insertions, 3 deletions
diff --git a/docs/pages/best_practices.adoc b/docs/pages/best_practices.adoc
index bfcedec06..eabaa9eb9 100644
--- a/docs/pages/best_practices.adoc
+++ b/docs/pages/best_practices.adoc
@@ -35,7 +35,7 @@ After the processing, another 1024 byte buffer will be placed on the stack to be
35 35
36Pass the data by reference and not by value on both, the way in and the way out. 36Pass the data by reference and not by value on both, the way in and the way out.
37For example, you could return a slice of the input buffer as the output. 37For example, you could return a slice of the input buffer as the output.
38Requiring the lifetime of the input slice and the output slice to be the same, the memory safetly of this procedure will be enforced by the compiler. 38Requiring the lifetime of the input slice and the output slice to be the same, the memory safety of this procedure will be enforced by the compiler.
39 39
40[,rust] 40[,rust]
41---- 41----
diff --git a/docs/pages/layer_by_layer.adoc b/docs/pages/layer_by_layer.adoc
index 7852d27b7..7dba11b5e 100644
--- a/docs/pages/layer_by_layer.adoc
+++ b/docs/pages/layer_by_layer.adoc
@@ -76,7 +76,7 @@ The async version looks very similar to the HAL version, apart from a few minor
76* The peripheral initialization is done by the main macro, and is handed to the main task. 76* The peripheral initialization is done by the main macro, and is handed to the main task.
77* Before checking the button state, the application is awaiting a transition in the pin state (low -> high or high -> low). 77* Before checking the button state, the application is awaiting a transition in the pin state (low -> high or high -> low).
78 78
79When `button.await_for_any_edge().await` is called, the executor will pause the main task and put the microcontroller in sleep mode, unless there are other tasks that can run. Internally, the Embassy HAL has configured the interrupt handler for the button (in `ExtiInput`), so that whenever an interrupt is raised, the task awaiting the button will be woken up. 79When `button.wait_for_any_edge().await` is called, the executor will pause the main task and put the microcontroller in sleep mode, unless there are other tasks that can run. Internally, the Embassy HAL has configured the interrupt handler for the button (in `ExtiInput`), so that whenever an interrupt is raised, the task awaiting the button will be woken up.
80 80
81The minimal overhead of the executor and the ability to run multiple tasks "concurrently" combined with the enormous simplification of the application, makes `async` a great fit for embedded. 81The minimal overhead of the executor and the ability to run multiple tasks "concurrently" combined with the enormous simplification of the application, makes `async` a great fit for embedded.
82 82
diff --git a/docs/pages/overview.adoc b/docs/pages/overview.adoc
index 6ac0e0b2b..a1bf180cd 100644
--- a/docs/pages/overview.adoc
+++ b/docs/pages/overview.adoc
@@ -74,7 +74,7 @@ include::embassy_in_the_wild.adoc[leveloffset = 2]
74 74
75For more reading material on async Rust and Embassy: 75For more reading material on async Rust and Embassy:
76 76
77* link:https://tweedegolf.nl/en/blog/65/async-rust-vs-rtos-showdown[Comparsion of FreeRTOS and Embassy] 77* link:https://tweedegolf.nl/en/blog/65/async-rust-vs-rtos-showdown[Comparison of FreeRTOS and Embassy]
78* link:https://dev.to/apollolabsbin/series/20707[Tutorials] 78* link:https://dev.to/apollolabsbin/series/20707[Tutorials]
79* link:https://blog.drogue.io/firmware-updates-part-1/[Firmware Updates with Embassy] 79* link:https://blog.drogue.io/firmware-updates-part-1/[Firmware Updates with Embassy]
80 80