Alias/rename 'include_get_headers' to 'match_headers' for clarity (backwards-compatibile)

4 files changed, 10 insertions, 10 deletions

diff --git a/requests_cache/backends/__init__.py b/requests_cache/backends/__init__.py
index 4a8f82c..2162551 100644
--- a/requests_cache/backends/__init__.py
+++ b/requests_cache/backends/__init__.py
@@ -16,7 +16,7 @@ BACKEND_KWARGS = CACHE_NAME_KWARGS + [
     'endpoint_url',
     'fast_save',
     'ignored_parameters',
-    'include_get_headers',
+    'match_headers',
     'name',
     'read_capacity_units',
     'region_name',
diff --git a/requests_cache/backends/base.py b/requests_cache/backends/base.py
index 67ef5ba..0562a0a 100644
--- a/requests_cache/backends/base.py
+++ b/requests_cache/backends/base.py
@@ -45,14 +45,14 @@ class BaseCache:
     def __init__(
         self,
         *args,
-        include_get_headers: bool = False,
+        match_headers: bool = False,
         ignored_parameters: Iterable[str] = None,
         key_fn: KEY_FN = None,
         **kwargs,
     ):
         self.responses: BaseStorage = DictStorage()
         self.redirects: BaseStorage = DictStorage()
-        self.include_get_headers = include_get_headers
+        self.match_headers = match_headers or kwargs.get('include_get_headers')
         self.ignored_parameters = ignored_parameters
         self.key_fn = key_fn or create_key
         self.name: str = kwargs.get('cache_name', '')
@@ -117,7 +117,7 @@ class BaseCache:
         return self.key_fn(
             request=request,
             ignored_parameters=self.ignored_parameters,
-            include_get_headers=self.include_get_headers,
+            match_headers=self.match_headers,
             **kwargs,
         )
 
diff --git a/requests_cache/cache_keys.py b/requests_cache/cache_keys.py
index e58bb14..b83aa9a 100644
--- a/requests_cache/cache_keys.py
+++ b/requests_cache/cache_keys.py
@@ -30,7 +30,7 @@ RequestContent = Union[Mapping, str, bytes]
 def create_key(
     request: AnyRequest = None,
     ignored_parameters: Iterable[str] = None,
-    include_get_headers: bool = False,
+    match_headers: bool = False,
     **kwargs,
 ) -> str:
     """Create a normalized cache key from a request object or :py:class:`~requests.Request`
@@ -51,7 +51,7 @@ def create_key(
     body = remove_ignored_body_params(request, ignored_parameters)
     if body:
         key.update(body)
-    if include_get_headers and request.headers != DEFAULT_HEADERS:
+    if match_headers and request.headers != DEFAULT_HEADERS:
         exclude_headers = list(ignored_parameters or []) + DEFAULT_EXCLUDE_HEADERS
         headers = normalize_dict(remove_ignored_headers(request, exclude_headers))
         if TYPE_CHECKING:
diff --git a/requests_cache/session.py b/requests_cache/session.py
index 97cdacc..2231532 100644
--- a/requests_cache/session.py
+++ b/requests_cache/session.py
@@ -291,16 +291,16 @@ class CachedSession(CacheMixin, OriginalSession):
 
     Args:
         cache_name: Cache prefix or namespace, depending on backend
-        backend: Cache backend name, or instance; name may be one of
-            ``['sqlite', 'mongodb', 'gridfs', 'redis', 'dynamodb', 'memory']``
+        backend: Cache backend name or instance; name may be one of
+            ``['sqlite', 'filesystem', 'mongodb', 'gridfs', 'redis', 'dynamodb', 'memory']``
         serializer: Serializer name or instance; name may be one of
             ``['pickle', 'json', 'yaml', 'bson']``.
         expire_after: Time after which cached items will expire
         urls_expire_after: Expiration times to apply for different URL patterns
         allowable_codes: Only cache responses with one of these status codes
         allowable_methods: Cache only responses for one of these HTTP methods
-        include_get_headers: Match request headers when reading from the cache
-        ignored_parameters: List of request parameters to exclude from the cache and not match
+        match_headers: Match request headers when reading from the cache
+        ignored_parameters: List of request parameters to not match against, and exclude from the cache
         filter_fn: Function that takes a :py:class:`~requests.Response` object and returns a boolean
             indicating whether or not that response should be cached. Will be applied to both new
             and previously cached responses.