diff options
author | Jordan Cook <jordan.cook@pioneer.com> | 2022-06-17 12:54:41 -0500 |
---|---|---|
committer | Jordan Cook <jordan.cook@pioneer.com> | 2022-06-17 13:59:47 -0500 |
commit | 59fc52e4a9d426da651d6fe93336ac8b2585c9b8 (patch) | |
tree | a8c581f5af5ce0e9c2e6dbf8d1ab993a6d763a42 /docs | |
parent | d9e246a2c8c25da0d7626df708cfcbf9725c5f8e (diff) | |
download | requests-cache-59fc52e4a9d426da651d6fe93336ac8b2585c9b8.tar.gz |
Related doc updates
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.md | 2 | ||||
-rw-r--r-- | docs/user_guide/expiration.md | 2 | ||||
-rw-r--r-- | docs/user_guide/filtering.md | 4 | ||||
-rw-r--r-- | docs/user_guide/general.md | 2 | ||||
-rw-r--r-- | docs/user_guide/headers.md | 1 |
5 files changed, 6 insertions, 5 deletions
diff --git a/docs/index.md b/docs/index.md index 9e011f7..f6e7e85 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,7 +29,7 @@ TODO: add script to make this conditional :maxdepth: 2 user_guide -reference examples +reference project_info ```` diff --git a/docs/user_guide/expiration.md b/docs/user_guide/expiration.md index 3ce196d..7b15386 100644 --- a/docs/user_guide/expiration.md +++ b/docs/user_guide/expiration.md @@ -84,7 +84,7 @@ You can use `urls_expire_after` to set different expiration values based on URL is equivalent to `http*://site.com/resource/**` - If there is more than one match, the first match will be used in the order they are defined - If no patterns match a request, `CachedSession.settings.expire_after` will be used as a default -- See {ref}`selective-caching` for an example of using `urls_expire_after` as an allowlist +- See {ref}`url-filtering` for an example of using `urls_expire_after` as an allowlist (request-errors)= ## Expiration and Error Handling diff --git a/docs/user_guide/filtering.md b/docs/user_guide/filtering.md index d514770..86a5afe 100644 --- a/docs/user_guide/filtering.md +++ b/docs/user_guide/filtering.md @@ -10,7 +10,7 @@ with a regular {py:class}`requests.Session` object, or wrapper functions like {py:func}`requests.get`, etc. ``` -(http-methods)= +(http-method-filtering)= ## Filter by HTTP Methods To cache additional HTTP methods, specify them with `allowable_methods`: ```python @@ -29,7 +29,7 @@ To cache additional status codes, specify them with `allowable_codes` >>> session.get('https://httpbin.org/teapot') ``` -(selective-caching)= +(url-filtering)= ## Filter by URLs You can use {ref}`URL patterns <url-patterns>` to define an allowlist for selective caching, by using a expiration value of `requests_cache.DO_NOT_CACHE` for non-matching request URLs: diff --git a/docs/user_guide/general.md b/docs/user_guide/general.md index 1f4b17c..20b6b2a 100644 --- a/docs/user_guide/general.md +++ b/docs/user_guide/general.md @@ -14,7 +14,7 @@ Basic usage looks like this: >>> session.get('https://httpbin.org/get') ``` -Any {py:class}`requests.Session` method can be used (but see {ref}`http-methods` section for +Any {py:class}`requests.Session` method can be used (but see {ref}`http-method-filtering` section for options): ```python >>> session.request('GET', 'https://httpbin.org/get') diff --git a/docs/user_guide/headers.md b/docs/user_guide/headers.md index a7e9441..5fd77b0 100644 --- a/docs/user_guide/headers.md +++ b/docs/user_guide/headers.md @@ -30,6 +30,7 @@ True Also see {ref}`stale-while-revalidate` for a variation of this behavior. ``` +(cache-control)= ## Cache-Control `Cache-Control` **request** headers will always be used if present. This is mainly useful if you are adding requests-cache to an existing application or library that already sends requests with cache |