Skip to content

Commit a975259

Browse files
committed
update readme example
1 parent 2b26e0f commit a975259

1 file changed

Lines changed: 18 additions & 6 deletions

File tree

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,30 @@ ArborParser is a powerful Python library designed to parse structured text docum
1313

1414
Given a text document with headings, ArborParser can parse and structure it as follows:
1515

16+
### Original Text
17+
```
18+
Chapter 1 Animals
19+
1.1 Mammals
20+
1.1.1 Primates
21+
1.2 Reptiles
22+
1.2.2 Crocodiles
23+
1.3 Birds
24+
1.3.1 Parrots
25+
1.3.2 Pigeons
26+
Chapter 2 Plants
27+
2.1 Angiosperms
28+
2.1.1 Dicotyledons
29+
2.1.2 Monocotyledons
30+
```
31+
1632
### Chain Structure
1733

1834
```
1935
LEVEL-[1]: Animals
2036
LEVEL-[1, 1]: Mammals
2137
LEVEL-[1, 1, 1]: Primates
2238
LEVEL-[1, 2]: Reptiles
23-
LEVEL-[1, 3, 3]: Snakes # wrong
24-
LEVEL-[1, 2, 2]: Crocodiles # hopefully inserted to the upper nearest 1.2
25-
LEVEL-[1, 2]: wrong 1.2 # create a new level as a child of 1
39+
LEVEL-[1, 2, 2]: Crocodiles
2640
LEVEL-[1, 3]: Birds
2741
LEVEL-[1, 3, 1]: Parrots
2842
LEVEL-[1, 3, 2]: Pigeons
@@ -40,9 +54,7 @@ ROOT
4054
│ ├─ 1.1 Mammals
4155
│ │ └─ 1.1.1 Primates
4256
│ ├─ 1.2 Reptiles
43-
│ │ └─ 1.2.2 Crocodiles # hopefully inserted to the upper nearest 1.2
44-
│ ├─ 1.3.3 Snakes # wrong
45-
│ ├─ 1.2 wrong 1.2 # create a new level as a child of 1
57+
│ │ └─ 1.2.2 Crocodiles
4658
│ └─ 1.3 Birds
4759
│ ├─ 1.3.1 Parrots
4860
│ └─ 1.3.2 Pigeons

0 commit comments

Comments
 (0)