Skip to content

Add a note about API stability and major breakages #278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add a note about API stability and major breakages #278

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@ conform to the WHATWG HTML specification, as is implemented by all major
web browsers.


API Stability
-------------

In line with `SemVer <http://semver.org/spec/v2.0.0.html>`_, we do not
guarantee API stability for 0.y.z releases.

A few major breakages include:

- beautifulsoup4 (bs4) requires html5lib<0.99999999 (minimum version
unknown!)

- bleach requires >=0.999,<0.99999999


Usage
-----

Expand Down