Skip to content

Commit 9f1b45b

Browse files
committed
CodeRabbit nitpicks
1 parent 896b3d7 commit 9f1b45b

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

documentation/modules/ROOT/pages/02-architecture.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ The potential events are transmitted to the _Event Mesh_.
100100
5. The dispatch loop continues until the event queue is empty and all the events are processed successfully.
101101
The failures are automatically retried by the _Event Mesh_, with an increasing pauses between retries to avoid overloading the system.
102102

103+
// TODO: Replace with custom graphics
103104
image::https://img.plantuml.biz/plantuml/svg/TPFDReGW483lFCNKkpw0XytMRDCqxJQRDdq05iULB885j35Dtxs8k2xxSuEPRpvm1jV6KcsxHf07MsE3m51t0gbCLMS5bqZCaSkMQjh0kBL3Yz0gCVWSOK9r9IHFFKeBMpHr0hy4WAccLNAC9Q-IMjuZ55eTKIT0JLWwxBl33Xr2goFr6RyYVuHKIfIe8TbofXKOr3rdQAxa6-tKsi3d17X7Y8MGuqjgwPuQNF1DSKvkYbZw8dl56PU7I3j5yPPsAGZYm5wAtvNb5MUk7qf6xlF4V81hmbdf6nue6y0Cnc9prOQGVMnRhvksqHK3CNzuCUf3B2tLZqnNOIevxBgzuAO676TgPYhJ_53RRELg8OUlrgdH-ybKjm1-XexPkTPoOsTFF1R815OZVUVK84tTlUB273xSmyGRN3oW-zoDPb_0brVDLijJoU4PhG4kAmLqxwgWd58aFjzNdTx1gMCX0XgPqgKXQvIb-_d-0G00[width=100%]
104105

105106
////

documentation/modules/ROOT/pages/03-demo.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public void completeTransit(Long driverId, UUID requestUUID, Address destination
5555
====
5656
There are issues with the above method.
5757
58-
<1> It uses the `+@Transational+` annotation, and modify number of unrelated data stores.
58+
<1> It uses the `+@Transactional+` annotation, and modifies multiple unrelated data stores.
5959
<2> It merges different, business domains.
6060
====
6161

@@ -75,7 +75,7 @@ In effect, the end-user will receive a nasty error message.
7575

7676
[NOTE]
7777
====
78-
Outages from the dependant services must not invalidate the main intent.
78+
Outages from the dependent services must not invalidate the main intent.
7979
In fact, all the operations in this example could happen independently, and at different, yet reasonable times.
8080
====
8181

@@ -87,7 +87,7 @@ The code starts small, easy to understand.
8787
When new features are added, it keeps growing as developers cramp new instructions into methods like `+completeTransit+`.
8888

8989
Of course, the developers could re-architect the code, to extract instructions to a separate blocks, but that is just a half-measure.
90-
Still, the application will do all the operations, starting from `+completeTransit+` method in the same time, and withing the same _"script"_.
90+
Still, the application will do all the operations, starting from `+completeTransit+` method in the same time, and within the same _"script"_.
9191

9292
[#_refactoring_plan]
9393
== Refactoring plan
@@ -107,6 +107,7 @@ After the refactoring, the `+completeTransit+` code will use two event types:
107107

108108
The diagram below shows the sequence of operations that happen when we initiate refactored `+completeTransit+` code.
109109

110+
// TODO: Replace with custom graphics
110111
image::https://www.plantuml.com/plantuml/svg/VP1DJiCm58JtFiMZ-rmWYwgqeHkeX2WNUBK7Ok4ubdyYzVQuZKbe5TZ5olTcFiqcHFOnTKOyn1OTIC8d0xPLdwBH5iBb_rfgnpRIwWMVBC_qwDoAED3ul4MUBKSzW9u6vES1eRsYMzz_mT-YZS-W3tJeLUwyOdlW23zeYJkK8vyuZ52p5O9bRk687uTYLgrB4zNqcav6XvPsR6GocTsZQ8d2L1aV3slQzVP3-uuKpCNgB1JkEwQpzI_FcjxoL5XgcUvdMioVL4soi-iuIOQcE5N259RYPgKYMNJ-3lfdkMPRqp7s7lJkjQFBvWihR61Lwimt[width=100%]
111112

112113
////

0 commit comments

Comments
 (0)