Skip to content

Commit c055d2f

Browse files
committed
📚 Updated docs for Lexer class
1 parent bf837b3 commit c055d2f

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

‎pydocit/md/Lexer.py

+24
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,30 @@ def __init__(self, value, start, end):
119119

120120

121121
class Lexer:
122+
"""
123+
This class parses the md markup text and converts in into
124+
a simple tree which can be used to converted into html or pdf
125+
according to the requirement.
126+
127+
The parsing occurs in order
128+
1. Heading1
129+
2. Heading2
130+
3. Heading3
131+
4. Heading4
132+
5. Heading5
133+
6. Heading6
134+
7. Bold_Text -> Undergoes parsing to check if contains any Links or Italic_Text
135+
8. Italic_Text -> Undergoes parsing to check if contains any Links
136+
9. Plain_Text -> Undergoes parsing to check if contains any Links
137+
138+
### TODO
139+
- Lists
140+
- Tables
141+
- Links
142+
- Images
143+
- Bold text
144+
- Italic Text
145+
"""
122146
def __init__(self, feed):
123147
self.feed = feed
124148
self.tokens = []

0 commit comments

Comments
 (0)