2009-08-21 16:29:23 -03:00
|
|
|
.. _api-stability:
|
2009-01-09 22:45:09 +00:00
|
|
|
|
|
|
|
|
============================
|
|
|
|
|
Versioning and API Stability
|
|
|
|
|
============================
|
|
|
|
|
|
2009-08-21 16:29:23 -03:00
|
|
|
API stability is one of Scrapy major goals.
|
2009-01-09 22:45:09 +00:00
|
|
|
|
|
|
|
|
Versioning
|
|
|
|
|
==========
|
|
|
|
|
|
2009-11-06 16:28:51 -02:00
|
|
|
When Scrapy reaches 1.0, each release will consist of three version numbers:
|
2009-01-09 22:45:09 +00:00
|
|
|
|
|
|
|
|
* major - big, backwards-incompatible changes
|
|
|
|
|
* minor - new features and backwards-compatible changes
|
|
|
|
|
* micro - bug fixes only
|
|
|
|
|
|
2009-11-06 16:28:51 -02:00
|
|
|
Until Scrapy reaches 1.0, minor releases (0.7, 0.8, etc) will follow the same
|
2009-11-06 16:49:48 -02:00
|
|
|
policy as major releases.
|
2009-11-06 16:28:51 -02:00
|
|
|
|
2009-01-09 22:45:09 +00:00
|
|
|
Sometimes the micro version can be omitted, for brevity, when it's not
|
|
|
|
|
relevant.
|
|
|
|
|
|
|
|
|
|
API Stability
|
|
|
|
|
=============
|
|
|
|
|
|
2009-04-10 05:35:53 +00:00
|
|
|
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
|
2009-08-21 16:29:23 -03:00
|
|
|
document the entire API, as we approach the 1.0 release.
|
2009-01-09 22:45:09 +00:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
