Skip to content

Commit 155caf2

Browse files
committed
docs: improve docstring of ApifyCacheStorage, describe usage
1 parent 3a2cc13 commit 155caf2

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/apify/scrapy/extensions/httpcache.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@
2828
class ApifyCacheStorage:
2929
"""A Scrapy cache storage that uses the Apify `KeyValueStore` to store responses.
3030
31-
This cache storage requires the asyncio Twisted reactor to be installed.
31+
It can be set as a storage for Scrapy's built-in `HttpCacheMiddleware`, which caches
32+
responses to requests. See HTTPCache middleware settings (prefixed with `HTTPCACHE_`)
33+
in the Scrapy documentation for more information. Requires the asyncio Twisted reactor
34+
to be installed.
3235
"""
3336

3437
def __init__(self, settings: BaseSettings) -> None:

0 commit comments

Comments
 (0)