aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHayleigh Thompson <me@hayleigh.dev>2024-02-23 01:05:24 +0000
committerHayleigh Thompson <me@hayleigh.dev>2024-02-23 01:05:24 +0000
commitec35aa7b34c250d86a5ad3ff887e330e3341fe1f (patch)
tree5008fa4fdefdad37354c3fb3b8315c3a611b73db
parentd91fd0b0dc50773dd106d0111790465d5735456d (diff)
downloadlustre-ec35aa7b34c250d86a5ad3ff887e330e3341fe1f.tar.gz
lustre-ec35aa7b34c250d86a5ad3ff887e330e3341fe1f.zip
:memo: Format notes consistently.
-rw-r--r--docs/guide/01-quickstart.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/guide/01-quickstart.md b/docs/guide/01-quickstart.md
index f8723a7..001e728 100644
--- a/docs/guide/01-quickstart.md
+++ b/docs/guide/01-quickstart.md
@@ -206,9 +206,9 @@ or `Decrement` message when clicked. The Lustre runtime is responsible for
attaching these event listeners and calling your `update` function with the
resulting message.
-**Note**: notice that the return type of `view` is `lustre.Element(Msg)`. The
-type parameter `Msg` tells us the kinds of messages this element might produce
-from events: type safety to the rescue!
+> **Note**: notice that the return type of `view` is `lustre.Element(Msg)`. The
+> type parameter `Msg` tells us the kinds of messages this element might produce
+> from events: type safety to the rescue!
This forms the core of every Lustre application:
@@ -317,10 +317,10 @@ fn get_cat() -> effect.Effect(Msg) {
}
```
-**Note**: The `get_cat` function returns an `Effect` that tells the runtime how
-to fetch a cat image. It's important to know that the `get_cat` function doesn't
-perform the request directly! This is why we need to add the `GotCat` message
-variant: the runtime needs to know what to do with the response when it arrives.
+> **Note**: The `get_cat` function returns an `Effect` that tells the runtime how
+> to fetch a cat image. It's important to know that the `get_cat` function doesn't
+> perform the request directly! This is why we need to add the `GotCat` message
+> variant: the runtime needs to know what to do with the response when it arrives.
This model of managed effects can feel cumbersome at first, but it comes with some
benefits. Forcing side effects to produce a message means our message type naturally