Document the use of repr() for annotation fingerprinting

scrapinghub · Dec 26, 2023 · 596431b · 596431b
1 parent bf93c2b
commit 596431b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/providers.rst b/docs/providers.rst
@@ -313,6 +313,9 @@ To have other settings respected, in addition to ``CONCURRENT_REQUESTS``, you'd
 need to use ``crawler.engine.download`` or something like that. Alternatively,
 you could implement those limits in the library itself.
 
+
+.. _annotated:
+
 Attaching metadata to dependencies
 ==================================
 

diff --git a/docs/settings.rst b/docs/settings.rst
@@ -122,3 +122,8 @@ custom request fingerprinter class to use for requests.
 This class is used to generate a base fingerprint for a request. If that
 request uses dependency injection, that fingerprint is then modified to account
 for requested dependencies. Otherwise, the fingerprint is used as is.
+
+.. note:: Annotations of :ref:`annotated dependencies <annotated>` are
+    serialized with :func:`repr` for fingerprinting purposes. If you find a
+    real-world scenario where this is a problem, please `open an issue
+    <https://github.com/scrapinghub/scrapy-poet/issues>`_.