Skip to content

Commit 75c9f93

Browse files
laroussolarousso
committed
Typo on documentation
1 parent a7588c6 commit 75c9f93

File tree

2 files changed

+37
-37
lines changed

2 files changed

+37
-37
lines changed

‎docs/manual/api.html‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@
150150
<div class="page-content row">
151151
<div class="small-12 large-9 column" id="docs">
152152
<h1><a href="#words-on-api" name="words-on-api" class="anchor"><span class="anchor-link"></span></a>Words on API</h1>
153-
<p>Thoth is non-blocking by default and rely on vavr but, you can choose if you use it or not.</p>
153+
<p>Thoth is non-blocking by default and rely on vavr but, you can choose if you want to use it or not.</p>
154154
<h2><a href="#fifty-shades-of-apis" name="fifty-shades-of-apis" class="anchor"><span class="anchor-link"></span></a>Fifty shades of APIs</h2>
155155
<h3><a href="#basic-api" name="basic-api" class="anchor"><span class="anchor-link"></span></a>Basic API</h3>
156156
<p>The basic API use vavr for several reasons :</p>
@@ -221,13 +221,13 @@ <h3><a href="#vanilla-api" name="vanilla-api" class="anchor"><span class="anchor
221221
}
222222
</code></pre>
223223
<h3><a href="#blocking-api" name="blocking-api" class="anchor"><span class="anchor-link"></span></a>Blocking API</h3>
224-
<p>If you don&rsquo;t to handle the non-blocking aspect, you can implement blocking interface, ie the blocking <code>CommandHandler</code>.</p>
224+
<p>If you don&rsquo;t want to handle the non-blocking aspect, you can implement blocking interface, ie the blocking <code>CommandHandler</code>.</p>
225225
<p>The component to use</p>
226226
<ul>
227227
<li><code>fr.maif.eventsourcing.blocking.CommandHandler</code> : with standard API (vavr)</li>
228228
<li><code>fr.maif.eventsourcing.vanilla.blocking.CommandHandler</code> : with vanilla API</li>
229229
</ul>
230-
<p>With the blocking API, you&rsquo;ll have to implement something like :</p>
230+
<p>With the blocking vanilla API, you&rsquo;ll have to implement something like :</p>
231231
<pre class="prettyprint"><code class="language-java">public class BankCommandHandler implements CommandHandler&lt;String, Account, BankCommand, BankEvent, List&lt;String&gt;, TxCtx&gt; {
232232

233233
@Override
@@ -276,14 +276,14 @@ <h3><a href="#reactive-api-using-reactor" name="reactive-api-using-reactor" clas
276276
<h2><a href="#cheat-sheet" name="cheat-sheet" class="anchor"><span class="anchor-link"></span></a>Cheat sheet</h2>
277277
<h3><a href="#concepts-and-vocabulary" name="concepts-and-vocabulary" class="anchor"><span class="anchor-link"></span></a>Concepts and vocabulary</h3>
278278
<ul>
279-
<li>a command : an action coming from the user that the system has to handle</li>
279+
<li>a command : an action from the user that the system must handle</li>
280280
<li>an event : something that append in the system</li>
281281
<li>a journal : a place where the events are stored</li>
282282
<li>a state or aggregate : the current state, the results of the previous events</li>
283283
<li>a projection : an alternative view of the events, this is a read model</li>
284284
</ul>
285285
<h3><a href="#overview-of-interface-to-implement" name="overview-of-interface-to-implement" class="anchor"><span class="anchor-link"></span></a>Overview of interface to implement</h3>
286-
<p>Here the list of interface you need or, you could implement (and the reason why).</p>
286+
<p>Here is the list of interface you need or, you could implement (and the reason why).</p>
287287
<table>
288288
<thead>
289289
<tr>
@@ -306,57 +306,57 @@ <h3><a href="#overview-of-interface-to-implement" name="overview-of-interface-to
306306
<tr>
307307
<td><code>CommandHandler</code> </td>
308308
<td>yes </td>
309-
<td>The component that handle commands and produce events </td>
309+
<td>The component that handles commands and produces events </td>
310310
</tr>
311311
<tr>
312312
<td><code>EventHandler</code> </td>
313313
<td>yes </td>
314-
<td>The component that handle events and produce a state </td>
314+
<td>The component that handles events and produces a state </td>
315315
</tr>
316316
<tr>
317317
<td><code>Projection</code> </td>
318318
<td>if you need read models </td>
319-
<td>The component that handle events and produce read model </td>
319+
<td>The component that handles events and produces read model </td>
320320
</tr>
321321
<tr>
322322
<td><code>AbstractDefaultAggregateStore</code> </td>
323323
<td>if you need snapshots </td>
324-
<td>The component that load state from events in the journal </td>
324+
<td>The component that loads state from events in the journal </td>
325325
</tr>
326326
<tr>
327327
<td><code>EventFormat</code> </td>
328328
<td>no </td>
329-
<td>The component that serialize / deserialize events </td>
329+
<td>The component that serializes / deserializes events </td>
330330
</tr>
331331
<tr>
332332
<td><code>JacksonEventFormat</code> </td>
333333
<td>yes (prefered) </td>
334-
<td>The component that serialize / deserialize events to json </td>
334+
<td>The component that serializes / deserializes events to json </td>
335335
</tr>
336336
<tr>
337337
<td><code>SimpleFormat</code> </td>
338338
<td>yes </td>
339-
<td>The component that serialize / deserialize events ignoring errors </td>
339+
<td>The component that serializes / deserializes events ignoring errors </td>
340340
</tr>
341341
<tr>
342342
<td><code>JacksonSimpleFormat</code> </td>
343343
<td>yes </td>
344-
<td>The component that serialize / deserialize events to json ignoring errors </td>
344+
<td>The component that serializes / deserializes events to json ignoring errors </td>
345345
</tr>
346346
<tr>
347347
<td><code>EventPublisher</code> </td>
348348
<td>no (only if don&rsquo;t use Kafka) </td>
349-
<td>The component that publish events </td>
349+
<td>The component that publishes events </td>
350350
</tr>
351351
<tr>
352352
<td><code>EventStore</code> </td>
353353
<td>no (only if don&rsquo;t use PG) </td>
354-
<td>The component that store and query events </td>
354+
<td>The component that stores and query events </td>
355355
</tr>
356356
<tr>
357357
<td><code>EventProcessor</code> </td>
358358
<td>no </td>
359-
<td>The component orchestrate all the magic </td>
359+
<td>The component orchestrates all the magic </td>
360360
</tr>
361361
</tbody>
362362
</table>

‎thoth-documentation/src/main/paradox/api.md‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Words on API
22

3-
Thoth is non-blocking by default and rely on vavr but, you can choose if you use it or not.
3+
Thoth is non-blocking by default and rely on vavr but, you can choose if you want to use it or not.
44

55
## Fifty shades of APIs
66

@@ -84,14 +84,14 @@ public class BankCommandHandler implements CommandHandler<String, Account, BankC
8484

8585
### Blocking API
8686

87-
If you don't to handle the non-blocking aspect, you can implement blocking interface, ie the blocking `CommandHandler`.
87+
If you don't want to handle the non-blocking aspect, you can implement blocking interface, ie the blocking `CommandHandler`.
8888

8989
The component to use
9090

9191
* `fr.maif.eventsourcing.blocking.CommandHandler` : with standard API (vavr)
9292
* `fr.maif.eventsourcing.vanilla.blocking.CommandHandler` : with vanilla API
9393

94-
With the blocking API, you'll have to implement something like :
94+
With the blocking vanilla API, you'll have to implement something like :
9595

9696
```java
9797
public class BankCommandHandler implements CommandHandler<String, Account, BankCommand, BankEvent, List<String>, TxCtx> {
@@ -149,28 +149,28 @@ public class BankCommandHandler implements CommandHandler<String, Account, BankC
149149

150150
### Concepts and vocabulary
151151

152-
* a command : an action coming from the user that the system has to handle
152+
* a command : an action from the user that the system must handle
153153
* an event : something that append in the system
154154
* a journal : a place where the events are stored
155155
* a state or aggregate : the current state, the results of the previous events
156156
* a projection : an alternative view of the events, this is a read model
157157

158158
### Overview of interface to implement
159159

160-
Here the list of interface you need or, you could implement (and the reason why).
161-
162-
| Interface | Required | Role |
163-
|---------------------------------|------------------------------|---------------------------------------------------------------------------|
164-
| `State` | yes | The current state built from events |
165-
| `Command` | yes | The command represents the data that comes in |
166-
| `CommandHandler` | yes | The component that handle commands and produce events |
167-
| `EventHandler` | yes | The component that handle events and produce a state |
168-
| `Projection` | if you need read models | The component that handle events and produce read model |
169-
| `AbstractDefaultAggregateStore` | if you need snapshots | The component that load state from events in the journal |
170-
| `EventFormat` | no | The component that serialize / deserialize events |
171-
| `JacksonEventFormat` | yes (prefered) | The component that serialize / deserialize events to json |
172-
| `SimpleFormat` | yes | The component that serialize / deserialize events ignoring errors |
173-
| `JacksonSimpleFormat` | yes | The component that serialize / deserialize events to json ignoring errors |
174-
| `EventPublisher` | no (only if don't use Kafka) | The component that publish events |
175-
| `EventStore` | no (only if don't use PG) | The component that store and query events |
176-
| `EventProcessor` | no | The component orchestrate all the magic |
160+
Here is the list of interface you need or, you could implement (and the reason why).
161+
162+
| Interface | Required | Role |
163+
|---------------------------------|------------------------------|-----------------------------------------------------------------------------|
164+
| `State` | yes | The current state built from events |
165+
| `Command` | yes | The command represents the data that comes in |
166+
| `CommandHandler` | yes | The component that handles commands and produces events |
167+
| `EventHandler` | yes | The component that handles events and produces a state |
168+
| `Projection` | if you need read models | The component that handles events and produces read model |
169+
| `AbstractDefaultAggregateStore` | if you need snapshots | The component that loads state from events in the journal |
170+
| `EventFormat` | no | The component that serializes / deserializes events |
171+
| `JacksonEventFormat` | yes (prefered) | The component that serializes / deserializes events to json |
172+
| `SimpleFormat` | yes | The component that serializes / deserializes events ignoring errors |
173+
| `JacksonSimpleFormat` | yes | The component that serializes / deserializes events to json ignoring errors |
174+
| `EventPublisher` | no (only if don't use Kafka) | The component that publishes events |
175+
| `EventStore` | no (only if don't use PG) | The component that stores and query events |
176+
| `EventProcessor` | no | The component orchestrates all the magic |

0 commit comments

Comments
 (0)