Skip to content

Commit 69bcc07

Browse files
slissonlanguitar
andcommitted
docs(modelql): apply suggestions from code review
Co-authored-by: Johannes Wienke <[email protected]>
1 parent 9774430 commit 69bcc07

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/global/modules/core/pages/explanation/modelql.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ While this results in a more predictable performance, it is also hard to maintai
1717
You have to download all the data at the beginning that you might eventually need, potentially exceeding the available memory of the system.
1818

1919
The ModelQL query language provides a more dynamic way of loading parts of the model on demand,
20-
but still allows to reduce the number of request to a minimum.
21-
The downside is, that it's not just a different implementation hidden behind the model-api,
20+
but still allows reducing the number of request to a minimum.
21+
The downside is that it's not just a different implementation hidden behind the model-api,
2222
but requires to use a different API.
2323

2424
== Reactive Streams

docs/global/modules/core/pages/howto/modelql.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ val result: List<String?> = client.query { root ->
1717
== Integration with LightModelClient
1818

1919
When creating a `LightModelClient` you can optionally provide a `ModelQLClient` instance,
20-
which allows to invoke `.query { ... }` (see below) on a node returned by the `LightModelClient`.
20+
which allows invoking `.query { ... }` (see below) on a node returned by the `LightModelClient`.
2121

2222
[source,kotlin]
2323
--
@@ -28,7 +28,7 @@ val result: List<String?> = client.getRootNode()!!.query {
2828
}
2929
--
3030

31-
== Type safe ModelQL API
31+
== Type-safe ModelQL API
3232

3333
You can use the `model-api-gen-gradle` plugin to generate type safe extensions from your meta-model.
3434
Specify the `modelqlKotlinDir` property to enable the generation.
@@ -139,8 +139,8 @@ val result: List<MyProduct> = query { db ->
139139
result.forEach { println("ID: ${it.id}, Title: ${it.title}, Images: ${it.images}") }
140140
--
141141

142-
At the beginning of the `buildLocalMapping` body you invoke `request()` on all the values you need to assemble your object.
143-
This basically ads the operand to the internal `zip` operation and returns an object that gives you access to the value
142+
At the beginning of the `buildLocalMapping` body, you invoke `request()` on all the values you need to assemble your object.
143+
This basically adds the operand to the internal `zip` operation and returns an object that gives you access to the value
144144
after receiving it from the server.
145145
Inside the `onSuccess` block you assemble the local object using the previously requested values.
146146

0 commit comments

Comments
 (0)