Skip to content

Commit c657e87

Browse files
authored
Merge pull request #2341 from christinerose/edit_readme-ppx
Line edits for README_PPX.md
2 parents 4a38c56 + 7fd85fa commit c657e87

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README_PPX.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## ppx_irmin
1+
## `ppx_irmin`
22

33
PPX extension for automatically generating Irmin type representations.
44

@@ -32,16 +32,16 @@ let tree_t leaf_t =
3232
Type representations can also be derived inline using the `[%typ: <core-type>]`
3333
extension point.
3434

35-
### Installation and usage
35+
### Installation and Usage
3636

3737
`ppx_irmin` may be installed via [opam](https://opam.ocaml.org/):
3838

3939
```
4040
opam install ppx_irmin
4141
```
4242

43-
If you're using the [dune](https://github.com/ocaml/dune) build system, add the
44-
following field to your `library`, `executable` or `test` stanza:
43+
If you're using the [Dune](https://github.com/ocaml/dune) build system, add the
44+
following field to your `library`, `executable`, or `test` stanza:
4545

4646
```
4747
(preprocess (pps ppx_irmin))
@@ -54,8 +54,8 @@ automatically derive an Irmin type representation with the same name.
5454

5555
`ppx_irmin` supports all of the type combinators exposed in the
5656
[Irmin.Type](https://docs.mirage.io/irmin/Irmin/Type/index.html) module (basic
57-
types, records, variants (plain and closed polymorphic), recursive types etc.).
58-
Types with parameters will result in parameterised representations (i.e. type
57+
types, records, variants (plain and closed polymorphic), recursive types, etc.).
58+
Types with parameters will result in parameterised representations (i.e., type
5959
`'a t` is generated a representation of type `'a Type.t -> 'a t Type.t`).
6060

6161
To supply base representations from a module other than `Irmin.Type` (such as
@@ -69,10 +69,10 @@ type foo = unit [@@deriving irmin { lib = Some "Mylib.Types" }]
6969
val foo_t = Mylib.Types.unit
7070
```
7171

72-
This argument can also be passed as a command-line option (i.e. `--lib
72+
This argument can also be passed as a command-line option (i.e., `--lib
7373
Mylib.Types`, with `--lib ''` interpreted as the current module).
7474

75-
#### Naming scheme
75+
#### Naming Scheme
7676

7777
The generated type representation will be called `<type-name>_t`, unless the
7878
type-name is `t`, in which case the representation is simply `t`. This
@@ -107,7 +107,7 @@ type t = unit [@nobuiltin] [@@deriving irmin]
107107
let t = unit_t (* not [Irmin.Type.unit] *)
108108
```
109109

110-
#### Signature type definitions
110+
#### Signature Type Definitions
111111

112112
The `ppx_irmin` deriver can also be used in signatures to expose the
113113
auto-generated value:

0 commit comments

Comments
 (0)