Skip to content

Commit 3ce9450

Browse files
committed
Update docstrings
1 parent 2efdd4f commit 3ce9450

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ using [Modest](https://github.com/lexborisov/Modest/) and [Lexbor](https://githu
77
It supports two backends:
88

99
- `Lexbor <https://github.com/lexbor/lexbor>`__ (preferred)
10-
- `Modest <https://github.com/lexborisov/Modest>`__ (first generation of lexbor)
10+
- `Modest <https://github.com/lexborisov/Modest>`__ (first generation of lexbor, **deprecated**)
1111

1212
API
1313
===

selectolax/parser.pyi

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -536,7 +536,9 @@ class Node:
536536
...
537537

538538
class HTMLParser:
539-
"""The HTML parser.
539+
"""The HTML parser using modest backend.
540+
541+
This backend is **deprecated**. Please use `lexbor` backend instead.
540542
541543
Use this class to parse raw HTML.
542544

selectolax/parser.pyx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ include "modest/util.pxi"
88
include "utils.pxi"
99

1010
cdef class HTMLParser:
11-
"""The HTML parser.
11+
"""The HTML parser using modest backend.
12+
13+
This backend is **deprecated**. Please use `lexbor` backend instead.
1214
1315
Use this class to parse raw HTML.
1416

0 commit comments

Comments
 (0)