aboutsummaryrefslogtreecommitdiff
path: root/src/lustre.gleam
diff options
context:
space:
mode:
authorHayleigh Thompson <me@hayleigh.dev>2024-02-23 01:03:51 +0000
committerHayleigh Thompson <me@hayleigh.dev>2024-02-23 01:03:51 +0000
commitd91fd0b0dc50773dd106d0111790465d5735456d (patch)
tree0512598cc282548af5c4b720ebd382552260b4c1 /src/lustre.gleam
parent16d8c583f7b42a8789d04d4b3b0f0bf0282832fa (diff)
downloadlustre-d91fd0b0dc50773dd106d0111790465d5735456d.tar.gz
lustre-d91fd0b0dc50773dd106d0111790465d5735456d.zip
:memo: Add a note reminding users this is a release candidate.
Diffstat (limited to 'src/lustre.gleam')
-rw-r--r--src/lustre.gleam11
1 files changed, 8 insertions, 3 deletions
diff --git a/src/lustre.gleam b/src/lustre.gleam
index a2c2fe2..884b6f5 100644
--- a/src/lustre.gleam
+++ b/src/lustre.gleam
@@ -1,3 +1,8 @@
+//// > **Note**: this is a _release candidate_ for v4.0.0 and documentation is still
+//// > a work in progress. If you spot an issue with docs or the library, or would
+//// > like to get involved, please [open an issue](https://github.com/lustre-labs/lustre/issues/new)
+//// > or a pull request.
+////
//// Lustre is a framework for rendering Web applications and components using
//// Gleam. This module contains the core API for constructing and communicating
//// with Lustre applications. If you're new to Lustre or frontend development in
@@ -306,9 +311,9 @@ pub type Error {
/// Take a look at the [`simple`](#simple) application constructor if you want to
/// build something interactive.
///
-/// **Note**: Just because an element doesn't have its own update loop, doesn't
-/// mean its content is always static! An element application may render a client
-/// or server component that has its own encapsulated update loop!
+/// > **Note**: Just because an element doesn't have its own update loop, doesn't
+/// > mean its content is always static! An element application may render a client
+/// > or server component that has its own encapsulated update loop!
///
pub fn element(html: Element(msg)) -> App(Nil, Nil, msg) {
let init = fn(_) { #(Nil, effect.none()) }