From 7458092eef74684bb38e80e837e11aa492636263 Mon Sep 17 00:00:00 2001 From: Pablo Hoffman Date: Sat, 29 Sep 2012 03:06:30 -0300 Subject: [PATCH] added spider contracts to release notes and warn that its API is still subject to change --- docs/news.rst | 3 +++ docs/topics/contracts.rst | 6 ++++++ 2 files changed, 9 insertions(+) diff --git a/docs/news.rst b/docs/news.rst index 7a78bf915..b1da92479 100644 --- 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 index 8e98bf749..ba1421c42 100644 --- 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 ` 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.