From 16efbf87fcb5368a454412501367a9cc1939df75 Mon Sep 17 00:00:00 2001 From: Pablo Hoffman Date: Fri, 30 Jan 2009 22:33:50 +0000 Subject: [PATCH] added some references to documentation and fixed some doc typos (thanks Patrick) --HG-- extra : convert_revision : svn%3Ab85faa78-f9eb-468e-a121-7cced6da292c%40813 --- .../trunk/scrapy/contrib/downloadermiddleware/common.py | 2 +- .../scrapy/contrib/downloadermiddleware/compression.py | 2 +- scrapy/trunk/scrapy/contrib/downloadermiddleware/retry.py | 2 +- scrapy/trunk/scrapy/contrib/spiders/crawl.py | 7 +++++++ scrapy/trunk/scrapy/contrib/spiders/feed.py | 8 +++++++- scrapy/trunk/scrapy/link/__init__.py | 2 ++ scrapy/trunk/scrapy/link/extractors.py | 5 +++-- scrapy/trunk/scrapy/spider/models.py | 4 +++- 8 files changed, 25 insertions(+), 7 deletions(-) diff --git a/scrapy/trunk/scrapy/contrib/downloadermiddleware/common.py b/scrapy/trunk/scrapy/contrib/downloadermiddleware/common.py index 793ed85ed..188a1f05f 100644 --- a/scrapy/trunk/scrapy/contrib/downloadermiddleware/common.py +++ b/scrapy/trunk/scrapy/contrib/downloadermiddleware/common.py @@ -1,5 +1,5 @@ """ -Common downloader middleare +Common downloader middleware See documentation in docs/ref/downloader-middleware.rst """ diff --git a/scrapy/trunk/scrapy/contrib/downloadermiddleware/compression.py b/scrapy/trunk/scrapy/contrib/downloadermiddleware/compression.py index 8d702e61d..74cd70c8d 100644 --- a/scrapy/trunk/scrapy/contrib/downloadermiddleware/compression.py +++ b/scrapy/trunk/scrapy/contrib/downloadermiddleware/compression.py @@ -32,7 +32,7 @@ class CompressionMiddleware(object): body = zlib.decompress(body) except zlib.error: # ugly hack to work with raw deflate content that may - # be sent by microsof servers. For more information, see: + # be sent by microsoft servers. For more information, see: # http://carsten.codimi.de/gzip.yaws/ # http://www.port80software.com/200ok/archive/2005/10/31/868.aspx # http://www.gzip.org/zlib/zlib_faq.html#faq38 diff --git a/scrapy/trunk/scrapy/contrib/downloadermiddleware/retry.py b/scrapy/trunk/scrapy/contrib/downloadermiddleware/retry.py index dbdb6277b..8d2eb3b4f 100644 --- a/scrapy/trunk/scrapy/contrib/downloadermiddleware/retry.py +++ b/scrapy/trunk/scrapy/contrib/downloadermiddleware/retry.py @@ -2,7 +2,7 @@ An extension to retry failed requests that are potentially caused by temporary problems such as a connection timeout or HTTP 500 error. -You can change the behaviour of this moddileware by modifing the scraping settings: +You can change the behaviour of this middleware by modifing the scraping settings: RETRY_TIMES - how many times to retry a failed page RETRY_HTTP_CODES - which HTTP response codes to retry diff --git a/scrapy/trunk/scrapy/contrib/spiders/crawl.py b/scrapy/trunk/scrapy/contrib/spiders/crawl.py index dc058976b..8d4a97b08 100644 --- a/scrapy/trunk/scrapy/contrib/spiders/crawl.py +++ b/scrapy/trunk/scrapy/contrib/spiders/crawl.py @@ -1,3 +1,10 @@ +""" +This modules implements the CrawlSpider which is the recommended spider to use +for scraping typical web sites that requires crawling pages. + +See documentation in docs/ref/spiders.rst +""" + import copy from scrapy.http import Request diff --git a/scrapy/trunk/scrapy/contrib/spiders/feed.py b/scrapy/trunk/scrapy/contrib/spiders/feed.py index 9829d3a3f..63020e6ed 100644 --- a/scrapy/trunk/scrapy/contrib/spiders/feed.py +++ b/scrapy/trunk/scrapy/contrib/spiders/feed.py @@ -1,4 +1,10 @@ -# -*- coding: utf8 -*- +""" +This module implements the XMLFeedSpider which is the recommended spider to use +for scraping from an XML feed. + +See documentation in docs/ref/spiders.rst +""" + from scrapy.spider import BaseSpider from scrapy.item import ScrapedItem from scrapy.http import Request diff --git a/scrapy/trunk/scrapy/link/__init__.py b/scrapy/trunk/scrapy/link/__init__.py index 0f93132a8..8cd19391c 100644 --- a/scrapy/trunk/scrapy/link/__init__.py +++ b/scrapy/trunk/scrapy/link/__init__.py @@ -1,5 +1,7 @@ """ LinkExtractor provides en efficient way to extract links from pages + +See documentation in docs/ref/link-extractors.rst """ from scrapy.utils.python import FixedSGMLParser, unique as unique_list diff --git a/scrapy/trunk/scrapy/link/extractors.py b/scrapy/trunk/scrapy/link/extractors.py index b6335ef99..a0daa46a9 100644 --- a/scrapy/trunk/scrapy/link/extractors.py +++ b/scrapy/trunk/scrapy/link/extractors.py @@ -1,7 +1,8 @@ """ -This module provides some LinkExtractors, which extend that base LinkExtractor -(scrapy.link.LinkExtractor) with some useful features. +This module provides some LinkExtractors, which extend the base LinkExtractor +(scrapy.link.LinkExtractor) with some addutional useful features. +See documentation in docs/ref/link-extractors.rst """ import re diff --git a/scrapy/trunk/scrapy/spider/models.py b/scrapy/trunk/scrapy/spider/models.py index 22e26d172..b53761623 100644 --- a/scrapy/trunk/scrapy/spider/models.py +++ b/scrapy/trunk/scrapy/spider/models.py @@ -1,5 +1,7 @@ """ -Base class for scrapy spiders +Base class for Scrapy spiders + +See documentation in docs/ref/spiders.rst """ from zope.interface import Interface, Attribute, invariant, implements from twisted.plugin import IPlugin