summaryrefslogtreecommitdiff
path: root/docs/examples.md
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2021-08-26 14:48:33 -0500
committerJordan Cook <jordan.cook@pioneer.com>2021-08-26 17:04:15 -0500
commite203a48cdf58eda51f85b27d3eaf852bd9da941c (patch)
treea384f2ab226fecc66b81bf288d51f2acb0b3b960 /docs/examples.md
parent31a760cfb998d31cdeb8f79e65e1f1765cb2e3c9 (diff)
downloadrequests-cache-e203a48cdf58eda51f85b27d3eaf852bd9da941c.tar.gz
Reorganize user docs: break down User Guide and Advanced Usage sections into smaller pages
Diffstat (limited to 'docs/examples.md')
-rw-r--r--docs/examples.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/examples.md b/docs/examples.md
index c59c662..5f9c737 100644
--- a/docs/examples.md
+++ b/docs/examples.md
@@ -1,3 +1,4 @@
+(examples)=
# Examples
This section contains some complete examples that demonstrate the main features of requests-cache.
@@ -93,15 +94,15 @@ The following scripts can also be found in the
:::
(custom_keys)=
-### Custom cache key function
-```{include} ../examples/custom_cache_keys.py
+### Custom request matcher
+```{include} ../examples/custom_request_matcher.py
:start-line: 2
:end-line: 15
```
:::{admonition} Example code
:class: toggle
-```{literalinclude} ../examples/custom_cache_keys.py
+```{literalinclude} ../examples/custom_request_matcher.py
:lines: 1,17-
```
:::