summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2021-09-05 13:21:32 -0500
committerJordan Cook <jordan.cook@pioneer.com>2021-09-06 17:39:15 -0500
commit8c05674c426298da7cd8a333c2dfce53151e041f (patch)
treee9bf7b6eb2a105ae6843cf1d74503aa95e0d964c /README.md
parent7ed1b4dffdd2254a6c319f23bab43df3f6fad91e (diff)
downloadrequests-cache-8c05674c426298da7cd8a333c2dfce53151e041f.tar.gz
Alias/rename 'include_get_headers' to 'match_headers' for clarity (backwards-compatibile)
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0caa1cd..3f8c5ff 100644
--- a/README.md
+++ b/README.md
@@ -102,7 +102,7 @@ session = CachedSession(
expire_after=timedelta(days=1), # Otherwise expire responses after one day
allowable_methods=['GET', 'POST'] # Cache POST requests to avoid sending the same data twice
allowable_codes=[200, 400] # Cache 400 responses as a solemn reminder of your failures
- include_get_headers=True, # Match all request headers
+ match_headers=True, # Match all request headers
ignored_parameters=['api_key'], # Don't match this param or save it in the cache
old_data_on_error=True, # In case of request errors, use stale cache data if possible
)