Skip to content

Commit b1cefe3

Browse files
committed
readme update
1 parent 141acf5 commit b1cefe3

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ https://blog.robertelder.org/diff-algorithm/
1616

1717
Additionally, the following is implemented on top of it:
1818

19-
* interpretation of the algorithms output
19+
* interpretation of the algorithm's output
2020
* customizable formatting of the interpreted result into a string (with a few provided out of the box formatters)
2121
* additional transformations for when the input is expected to be a sequence of tokens (`TokenDiff`)
2222

@@ -103,7 +103,7 @@ StringDiff
103103
]
104104
```
105105

106-
Here, the following list of DiffElements:
106+
Here, the following list of `DiffElement`s:
107107

108108
```
109109
[
@@ -122,7 +122,7 @@ got collapsed into a single one:
122122
]
123123
```
124124

125-
In a nutshell, collapsing removes empty elements and joins same or otherwise "joinable" subsequent `DiffElements`.
125+
In a nutshell, collapsing removes empty elements and joins same or otherwise "join-able" subsequent `DiffElement`s.
126126

127127
Examples:
128128
* any `InFirst`, `InLast`, `Diff` or `InBoth` gets removed if the element is empty
@@ -155,7 +155,7 @@ SeqDiff
155155

156156
### Diff'ing strings:
157157

158-
Raw diff:
158+
##### Raw diff AST:
159159

160160
```scala
161161
println(
@@ -178,7 +178,7 @@ Raw diff:
178178
]
179179
```
180180

181-
Text output:
181+
##### Text output:
182182

183183
```scala
184184
println(
@@ -193,7 +193,7 @@ Text output:
193193
[∅|a]]bc][de|xy]]fg][z|∅]]i][o|∅]
194194
```
195195

196-
ANSI color output:
196+
##### ANSI color output:
197197

198198
```scala
199199
println(
@@ -236,7 +236,7 @@ With a `StringDiff` the output would look like the following:
236236
```
237237
![screenshot4](doc/images/screenshot3.png)
238238

239-
Inline diffs for both strings:
239+
##### Inline diffs for both strings
240240

241241
```scala
242242
println(
@@ -252,15 +252,16 @@ Inline diffs for both strings:
252252

253253
### Usage
254254

255-
Diff'ing `Seq`s:
255+
##### Diff'ing `Seq`s:
256+
256257
```
257258
SeqDiff.seq(
258259
Seq(1, 2, 3),
259260
Seq(2, 3, 4)
260261
)
261262
```
262263

263-
Diff'ing `Strings`s:
264+
##### Diff'ing `Strings`s:
264265

265266
```
266267
StringDiff.ansi("abc", "acb")
@@ -274,7 +275,7 @@ StringDiff.raw("abc", "acb")
274275
```
275276

276277

277-
Diff'ing `Strings`s with tokens:
278+
##### Diff'ing `Strings`s with tokens:
278279

279280
```
280281
TokenDiff.ansi("abc", "acb")
@@ -300,7 +301,7 @@ trait DiffFormat[Out] {
300301
}
301302
```
302303

303-
```
304+
```scala
304305
object MyFormat extends DiffFormat[MyDiffOutput] { ... }
305306

306307
val diff: MyDiffOutput = MyFormat(StringDiff("abc", "acb"))
@@ -340,7 +341,6 @@ object TextDiffFormat extends DiffFormat[String] {
340341
}
341342
```
342343

343-
344344
## Author
345345

346346
Iurii Malchenko – [@yurique](https://twitter.com/yurique)

0 commit comments

Comments
 (0)