example/h-sql: document Lwt.bind

aantron · Dec 10, 2024 · d44447d · d44447d
1 parent da94944
commit d44447d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/example/h-sql/README.md b/example/h-sql/README.md
@@ -7,6 +7,10 @@ prepared statements using
 [Caqti](https://paurkedal.github.io/ocaml-caqti/caqti/Caqti_connect_sig/module-type-S/module-type-CONNECTION/index.html),
 a library for talking to SQL databases:
 
+> [!TIP]
+> The `let%lwt` syntax is syntactic sugar for `Lwt.bind`, so the two forms below are equivalent (a third option would be using `>>=`).
+> For more information, see [here](https://ocsigen.org/lwt/latest/api/Lwt#3_Callbacks).
+
 ```ocaml
 module type DB = Caqti_lwt.CONNECTION
 module T = Caqti_type
@@ -17,8 +21,7 @@ let list_comments =
     (T.unit ->* T.(tup2 int string))
     "SELECT id, text FROM comment" in
   fun (module Db : DB) ->
-    let%lwt comments_or_error = Db.collect_list query () in
-    Caqti_lwt.or_fail comments_or_error
+    Lwt.bind (Db.collect_list query ()) Caqti_lwt.or_fail
 
 let add_comment =
   let query =

diff --git a/example/h-sql/sql.eml.ml b/example/h-sql/sql.eml.ml
@@ -7,8 +7,7 @@ let list_comments =
     (T.unit ->* T.(t2 int string))
     "SELECT id, text FROM comment" in
   fun (module Db : DB) ->
-    let%lwt comments_or_error = Db.collect_list query () in
-    Caqti_lwt.or_fail comments_or_error
+    Lwt.bind (Db.collect_list query ()) Caqti_lwt.or_fail
 
 let add_comment =
   let query =