Skip to content

Commit 7ff8da5

Browse files
committed
Add a note about API stability and major breakages
1 parent 14d4851 commit 7ff8da5

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,20 @@ conform to the WHATWG HTML specification, as is implemented by all major
99
web browsers.
1010

1111

12+
API Stability
13+
-------------
14+
15+
In line with `SemVer <http://semver.org/spec/v2.0.0.html>`_, we do not
16+
guarantee API stability for 0.y.z releases.
17+
18+
A few major breakages include:
19+
20+
- beautifulsoup4 (bs4) requires html5lib<0.99999999 (minimum version
21+
unknown!)
22+
23+
- bleach requires >=0.999,<0.99999999
24+
25+
1226
Usage
1327
-----
1428

0 commit comments

Comments
 (0)