diff options
| author | Parker Hancock <633163+parkerhancock@users.noreply.github.com> | 2021-06-03 16:00:02 -0500 |
|---|---|---|
| committer | Parker Hancock <633163+parkerhancock@users.noreply.github.com> | 2021-06-03 16:00:02 -0500 |
| commit | 6465c8bf137dea873ae8b37998625edf9efff0b5 (patch) | |
| tree | 24fd4256a13298f85a420905ab6163e69b31e84c /docs | |
| parent | a47c58660348537e5915d4bc203f7a6109f7de9d (diff) | |
| download | requests-cache-6465c8bf137dea873ae8b37998625edf9efff0b5.tar.gz | |
adding note about ignored_parameters being removed from cached request data
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/user_guide.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/user_guide.rst b/docs/user_guide.rst index 222f14d..d089aeb 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -179,8 +179,9 @@ or credentials. If you want to ignore specific parameters, specify them with ``i >>> session.get('http://httpbin.org/get', params={'auth-token': 'D9FAEB3449D3'}) In addition to allowing the cache to ignore these parameters when fetching cached results, these -parameters will also be removed from the cache data. This makes ``ignored_parameters`` a good way to -prevent key material or other secrets from being saved in the cache backend. +parameters will also be removed from the cache data, including in the request headers. +This makes ``ignored_parameters`` a good way to prevent key material or other secrets from being +saved in the cache backend. Request Headers ~~~~~~~~~~~~~~~ |