added spider contracts to release notes and warn that its API is stil…

…l subject to change
LaoKong · Sep 29, 2012 · 7458092 · 7458092
1 parent 34f1477
commit 7458092
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/news.rst b/docs/news.rst
@@ -1,3 +1,5 @@
+.. _news:
+
 Release notes
 =============
 
@@ -6,6 +8,7 @@ Release notes
 
 Scrapy changes:
 
+- added :ref:`topics-contracts`, a mechanism for testing spiders in a formal/reproducible way
 - added options ``-o`` and ``-t`` to the :command:`runspider` command
 - documented :doc:`topics/autothrottle` and added to extensions installed by default. You still need to enable it with :setting:`AUTOTHROTTLE_ENABLED`
 - major Stats Collection refactoring: removed separation of global/per-spider stats, removed stats-related signals (``stats_spider_opened``, etc). Stats are much simpler now, backwards compatibility is kept on the Stats Collector API and signals.

diff --git a/docs/topics/contracts.rst b/docs/topics/contracts.rst
@@ -4,6 +4,12 @@
 Spiders Contracts
 =================
 
+.. versionadded:: 0.15
+
+.. note:: This is a new feature (introduced in Scrapy 0.15) and may be subject
+   to minor functionality/API updates. Check the :ref:`release notes <news>` to
+   be notified of updates.
+
 Testing spiders can get particularly annoying and while nothing prevents you
 from writing unit tests the task gets cumbersome quickly. Scrapy offers an
 integrated way of testing your spiders by the means of contracts.