summaryrefslogtreecommitdiff
path: root/docs/user_guide
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2022-04-18 13:19:13 -0500
committerJordan Cook <jordan.cook@pioneer.com>2022-04-18 13:40:23 -0500
commitd2a4c9938e43aa6de9e54a150fad44650af6a7e1 (patch)
treeb11c2a5ab356486c7f76ebee212850c4bc7dc3e7 /docs/user_guide
parent1114085dbb38be59ecb862f77e752772d7b55ca1 (diff)
downloadrequests-cache-d2a4c9938e43aa6de9e54a150fad44650af6a7e1.tar.gz
Add links to source files on Examples page
Diffstat (limited to 'docs/user_guide')
-rw-r--r--docs/user_guide/compatibility.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/user_guide/compatibility.md b/docs/user_guide/compatibility.md
index fff338c..fcd5304 100644
--- a/docs/user_guide/compatibility.md
+++ b/docs/user_guide/compatibility.md
@@ -141,7 +141,7 @@ Or if you use a `CachedSession` object, you could replace it with a regular `Ses
If you want both caching and mocking features at the same time, you can attach requests-mock's
[adapter](https://requests-mock.readthedocs.io/en/latest/adapter.html) to a `CachedSession`:
-:::{admonition} Example: test_requests_mock_combine_cache.py
+:::{admonition} Example: `test_requests_mock_combine_cache.py`
:class: toggle
```{literalinclude} ../../tests/compat/test_requests_mock_combine_cache.py
```
@@ -157,7 +157,7 @@ This has the advantage of only using request-mock's behavior for
```
To turn that into a complete example:
-:::{admonition} Example: test_requests_mock_load_cache.py
+:::{admonition} Example: `test_requests_mock_load_cache.py`
:class: toggle
```{literalinclude} ../../tests/compat/test_requests_mock_load_cache.py
```
@@ -167,7 +167,7 @@ To turn that into a complete example:
Usage with the [responses](https://github.com/getsentry/responses) library is similar to the
requests-mock examples above.
-:::{admonition} Example: test_responses_load_cache.py
+:::{admonition} Example: `test_responses_load_cache.py`
:class: toggle
```{literalinclude} ../../tests/compat/test_responses_load_cache.py
```
@@ -177,7 +177,7 @@ requests-mock examples above.
If you would like to reuse your cached response data for unit tests, one option is to convert your
cache into a format compatible with VCR-vased libraries like
[vcrpy](https://github.com/kevin1024/vcrpy) and [betamax](https://github.com/betamaxpy/betamax).
-:::{admonition} Example: vcr.py
+:::{admonition} Example: `vcr.py`
:class: toggle
```{literalinclude} ../../examples/vcr.py
:lines: 7-