Skip to content

Commit 3b47761

Browse files
committed
Additional fixes to the docs
1 parent 0549068 commit 3b47761

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/plutarch.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ For a full example see [Example](#example).
4141

4242
## LambdaBuffers modules
4343

44-
Writing .lbf schemas with API types intended for Plutarch backend will typically use the following LambdaBuffers modules:
44+
Writing .lbf schemas with API types intended for Plutarch backend will typically use the following LambdaBuffers schema modules:
4545

4646
1. [Prelude](../libs/lbf-prelude/Prelude.lbf),
4747
2. [Plutus.V1](../libs/lbf-plutus/Plutus/V1.lbf),
@@ -54,10 +54,10 @@ Take a look at [Example.lbf](./plutarch/api/Example.lbf) schema as an example.
5454
The necessary LambdaBuffers runtime libraries a typical Plutarch project needs when working with LambdaBuffers:
5555

5656
1. [lbr-plutarch](../runtimes/haskell/lbr-plutarch) a Haskell runtime library necessary for working with `lbf-xyz` libraries.
57-
2. [lbf-prelude-plutarch](../libs/lbf-prelude) that contains the [LambdaBuffers Prelude](../libs/lbf-prelude) package generated by LambdaBuffers.
58-
3. [lbf-plutus-plutarch](../libs/lbf-plutus) that contains the [LambdaBuffers Plutus](../libs/lbf-plutus) package generated by LambdaBuffers.
57+
2. [lbf-prelude-plutarch](../libs/lbf-prelude) that contains the [LambdaBuffers Prelude](../libs/lbf-prelude) schema library generated by LambdaBuffers.
58+
3. [lbf-plutus-plutarch](../libs/lbf-plutus) that contains the [LambdaBuffers Plutus](../libs/lbf-plutus) schema library generated by LambdaBuffers.
5959

60-
Of course, additionally imports for Plutarch libraries is also necessary [plutarch](https://github.com/Plutonomicon/plutarch-plutus) and optionally [plutarch-extra](https://github.com/Plutonomicon/plutarch-plutus/plutarch-extra).
60+
Of course, additional imports for Plutarch libraries are also necessary [plutarch](https://github.com/Plutonomicon/plutarch-plutus) and optionally [plutarch-extra](https://github.com/Plutonomicon/plutarch-plutus/plutarch-extra).
6161

6262
For a full example see [Example](#example).
6363

@@ -86,7 +86,7 @@ result/autogen/LambdaBuffers/Plutus/V1/Plutarch.hs
8686

8787
## Haskell modules
8888

89-
The set of imports a Haskell module using LambdaBuffers modules would typically need is the following:
89+
The set of imports a Plutarch program using LambdaBuffers would typically need is the following:
9090

9191
```haskell
9292
import LambdaBuffers.Plutus.V1.Plutarch ()
@@ -153,9 +153,9 @@ The Plutarch backend doesn't support the use of `Char`, `Text`, `Bytes` (there's
153153

154154
### Type definition mapping
155155

156-
Plutarch backend supports all types from the LambdaBuffers Plutus module, as to enable full featured Plutus script development.
156+
Plutarch backend supports all types from the [LambdaBuffers Plutus](../libs/lbf-plutus) schema library, as to enable full featured Plutus script development.
157157

158-
Additionally, it also supports some types from the LambdaBuffers Prelude module, namely `Bool`, `Integer`, `Maybe`, `Either` and `List`.
158+
Additionally, it also supports some types from the [LambdaBuffers Prelude](../libs/lbf-prelude) schema library, namely `Bool`, `Integer`, `Maybe`, `Either` and `List`.
159159

160160
```lbf
161161
module Foo
@@ -310,7 +310,7 @@ infix 4 #==
310310

311311
> We don't generate an implementation from the LambdaBuffers 'equality spec', rather we delegate the equality check to the underlying 'PData' representations that all generated types have for performance.
312312
313-
### PShow
313+
#### PShow
314314

315315
All generated types have a PShow instance derived using the internal Plutarch deriving mechanism.
316316

@@ -322,7 +322,7 @@ Let work through the [Plutarch example](./plutarch) available in the repo.
322322

323323
First, please check the [Getting started](getting-started.md) guide on how to prepare to work with the repo and setup Nix.
324324

325-
### Directory contents
325+
Let's see what we have here:
326326

327327
```shell
328328
lambda-buffers/docs/plutarch ❯ find

0 commit comments

Comments
 (0)