Broader sweep of stale module-level docstrings (#7699)

Extends the previous pass to 28 more modules that had the same
redundant pattern: a one-line description restating the module/class
name plus a "See documentation in docs/topics/*.rst" pointer, with no
information not already present in the linked docs or in class
docstrings pulled into the docs via autoclass/autodoc.

Verified per file that nothing unique was lost, e.g. the Selector
type-inference behavior described in html.py/xml.py is already
documented on scrapy.Selector (autoclass'd in docs/topics/selectors.rst),
and CrawlSpider/XMLFeedSpider/CSVFeedSpider details are documented in
docs/topics/spiders.rst in more depth than the module docstrings had.
This commit is contained in:
Siddhesh Kulkarni 2026-07-02 11:57:07 -07:00
parent a382da4b60
commit 2ae0a3ca64
29 changed files with 0 additions and 187 deletions

View File

@ -1,9 +1,3 @@
"""
Scrapy Shell
See documentation in docs/topics/shell.rst
"""
from __future__ import annotations
import asyncio

View File

@ -1,9 +1,3 @@
"""
Downloader Middleware manager
See documentation in docs/topics/downloader-middleware.rst
"""
from __future__ import annotations
import warnings

View File

@ -1,9 +1,3 @@
"""
Spider Middleware manager
See documentation in docs/topics/spider-middleware.rst
"""
from __future__ import annotations
import logging

View File

@ -1,9 +1,3 @@
"""
DefaultHeaders downloader middleware
See documentation in docs/topics/downloader-middleware.rst
"""
from __future__ import annotations
from typing import TYPE_CHECKING

View File

@ -1,9 +1,3 @@
"""
HTTP basic auth downloader middleware
See documentation in docs/topics/downloader-middleware.rst
"""
from __future__ import annotations
import warnings

View File

@ -1,9 +1,3 @@
"""CloseSpider is an extension that forces spiders to be closed after certain
conditions are met.
See documentation in docs/topics/extensions.rst
"""
from __future__ import annotations
import logging

View File

@ -1,9 +1,3 @@
"""
Extensions for debugging Scrapy
See documentation in docs/topics/extensions.rst
"""
from __future__ import annotations
import contextlib

View File

@ -1,9 +1,3 @@
"""
Feed Exports extension
See documentation in docs/topics/feed-exports.rst
"""
from __future__ import annotations
import asyncio

View File

@ -1,9 +1,3 @@
"""
MemoryDebugger extension
See documentation in docs/topics/extensions.rst
"""
from __future__ import annotations
import gc

View File

@ -1,9 +1,3 @@
"""
MemoryUsage extension
See documentation in docs/topics/extensions.rst
"""
from __future__ import annotations
import logging

View File

@ -1,9 +1,3 @@
"""
Scrapy Telnet Console extension
See documentation in docs/topics/telnetconsole.rst
"""
from __future__ import annotations
import binascii

View File

@ -1,10 +1,3 @@
"""
This module implements the Request class which is used to represent HTTP
requests in Scrapy.
See documentation in docs/topics/request-response.rst
"""
from __future__ import annotations
import inspect

View File

@ -1,10 +1,3 @@
"""
This module implements the FormRequest class which is a more convenient class
(than Request) to generate Requests based on form data.
See documentation in docs/topics/request-response.rst
"""
from __future__ import annotations
from collections.abc import Iterable

View File

@ -1,10 +1,3 @@
"""
This module implements the JsonRequest class which is a more convenient class
(than Request) to generate JSON Requests.
See documentation in docs/topics/request-response.rst
"""
from __future__ import annotations
import copy

View File

@ -1,10 +1,3 @@
"""
This module implements the XmlRpcRequest class which is a more convenient class
(that Request) to generate xml-rpc requests.
See documentation in docs/topics/request-response.rst
"""
from __future__ import annotations
import xmlrpc.client as xmlrpclib

View File

@ -1,10 +1,3 @@
"""
This module implements the Response class which is used to represent HTTP
responses in Scrapy.
See documentation in docs/topics/request-response.rst
"""
from __future__ import annotations
from typing import TYPE_CHECKING, Any, AnyStr, TypeVar, overload

View File

@ -1,11 +1,3 @@
"""
This module implements the :class:`HtmlResponse` class which is used as a
content type marker by :class:`~scrapy.selector.Selector` and can be used in
``isinstance()`` checks.
See documentation in docs/topics/request-response.rst
"""
from scrapy.http.response.text import TextResponse

View File

@ -1,10 +1,3 @@
"""
This module implements the JsonResponse class that is used when the response
has a JSON MIME type in its Content-Type header.
See documentation in docs/topics/request-response.rst
"""
from scrapy.http.response.text import TextResponse

View File

@ -1,10 +1,3 @@
"""
This module implements the TextResponse class which adds encoding handling and
discovering (through HTTP headers) to base Response class.
See documentation in docs/topics/request-response.rst
"""
from __future__ import annotations
import json

View File

@ -1,11 +1,3 @@
"""
This module implements the :class:`XmlResponse` class which is used as a
content type marker by :class:`~scrapy.selector.Selector` and can be used in
``isinstance()`` checks.
See documentation in docs/topics/request-response.rst
"""
from scrapy.http.response.text import TextResponse

View File

@ -1,9 +1,3 @@
"""
Scrapy Item
See documentation in docs/topics/items.rst
"""
from __future__ import annotations
from abc import ABCMeta

View File

@ -1,9 +1,3 @@
"""
Item pipeline
See documentation in docs/topics/item-pipeline.rst
"""
from __future__ import annotations
import asyncio

View File

@ -1,9 +1,3 @@
"""Scrapy Shell
See documentation in docs/topics/shell.rst
"""
from __future__ import annotations
import asyncio

View File

@ -1,9 +1,3 @@
"""
Depth Spider Middleware
See documentation in docs/topics/spider-middleware.rst
"""
from __future__ import annotations
import logging

View File

@ -1,9 +1,3 @@
"""
HttpError Spider Middleware
See documentation in docs/topics/spider-middleware.rst
"""
from __future__ import annotations
import logging

View File

@ -1,9 +1,3 @@
"""
Url Length Spider Middleware
See documentation in docs/topics/spider-middleware.rst
"""
from __future__ import annotations
import logging

View File

@ -1,9 +1,3 @@
"""
Base class for Scrapy spiders
See documentation in docs/topics/spiders.rst
"""
from __future__ import annotations
import logging

View File

@ -1,10 +1,3 @@
"""
This modules implements the CrawlSpider which is the recommended spider to use
for scraping typical websites that requires crawling pages.
See documentation in docs/topics/spiders.rst
"""
from __future__ import annotations
import copy

View File

@ -1,10 +1,3 @@
"""
This module implements the XMLFeedSpider which is the recommended spider to use
for scraping from an XML feed.
See documentation in docs/topics/spiders.rst
"""
from __future__ import annotations
from typing import TYPE_CHECKING, Any