RomanNum3ral
/
scrapy
mirror of https://github.com/scrapy/scrapy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
scrapy/docs/api-stability.rst

853 B
Raw Permalink Blame History

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> </head>

Versioning and API Stability

API stability is one of Scrapy major goals.

Versioning

Each Scrapy release consists of three version numbers:

  • major - big, backwards-incompatible changes
  • minor - new features and backwards-compatible changes
  • micro - bug fixes only

Sometimes the micro version can be omitted, for brevity, when it's not relevant.

API Stability

Methods or functions that start with a single dash (_) are private and should never be relied as stable. Besides those, the plan is to stabilize and document the entire API, as we approach the 1.0 release.

Also, keep in mind that stable doesn't mean complete: stable APIs could grow new methods or functionality but the existing methods should keep working the same way.

</html>