From 421711be10d637eeac23a45f094d84992798b820 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philip=20K=2EF=2E=20H=C3=B6lzenspies?= Date: Wed, 16 Oct 2024 13:10:48 +0100 Subject: [PATCH] Improve let-expression examples (#680) (#699) Because I did not understand what a `Let Expression` should be and the example code was more confusing as explanatory, I changed the format of the examples a little bit and changed the result. - It should be clear that the example is just one code-line - I tried out the example (`pkl eval...`) and get a little bit different result Co-authored-by: ManuW --- .../language-reference/pages/index.adoc | 23 +++++++++++-------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/modules/language-reference/pages/index.adoc b/docs/modules/language-reference/pages/index.adoc index 17004418..50a3086d 100644 --- a/docs/modules/language-reference/pages/index.adoc +++ b/docs/modules/language-reference/pages/index.adoc @@ -3378,10 +3378,11 @@ Here is an example: [source%tested,{pkl}] ---- -birdDiets = let (diets = List("Seeds", "Berries", "Mice")) -List(diets[2], diets[0]) // <1> +birdDiets = + let (diets = List("Seeds", "Berries", "Mice")) + List(diets[2], diets[0]) // <1> ---- -<1> result: `List("Mice", "Seeds")` +<1> result: `birdDiets = List("Mice", "Seeds")` `let` expressions serve two purposes: @@ -3392,20 +3393,22 @@ List(diets[2], diets[0]) // <1> [source%tested,{pkl}] ---- -birdDiets = let (diets: List = List("Seeds", "Berries", "Mice")) -diets[2] + diets[0] // <1> +birdDiets = + let (diets: List = List("Seeds", "Berries", "Mice")) + diets[2] + diets[0] // <1> ---- -<1> result: `List("Mice", "Seeds")` +<1> result: `birdDiets = List("Mice", "Seeds")` `let` expressions can be stacked: [source%tested,{pkl}] ---- -birdDiets = let (birds = List("Pigeon", "Barn owl", "Parrot")) -let (diet = List("Seeds", "Mice", "Berries")) -birds.zip(diet) // <1> +birdDiets = + let (birds = List("Pigeon", "Barn owl", "Parrot")) + let (diet = List("Seeds", "Mice", "Berries")) + birds.zip(diet) // <1> ---- -<1> result: `List(Pair("Pigeon", "Seeds"), Pair("Barn owl", "Mice"), Pair("Parrot", "Berries"))` +<1> result: `birdDiets = List(Pair("Pigeon", "Seeds"), Pair("Barn owl", "Mice"), Pair("Parrot", "Berries"))` [[type-tests]] === Type Tests