summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2021-04-13 13:53:00 -0500
committerJordan Cook <jordan.cook@pioneer.com>2021-04-16 21:40:23 -0500
commit35561110e8f52ad0ab03d40dcc64d88e654aeff5 (patch)
tree6817141d7297cb0f5ac042b893447c11f0330ac9 /examples
parent583d960febe319de596ea0a9761f1bcb6bf2ddf6 (diff)
downloadrequests-cache-35561110e8f52ad0ab03d40dcc64d88e654aeff5.tar.gz
Include example scripts on readthedocs
Diffstat (limited to 'examples')
-rw-r--r--examples/README.md3
-rwxr-xr-xexamples/basic_usage.py4
-rwxr-xr-xexamples/convert_cache.py3
-rwxr-xr-xexamples/expiration.py4
-rwxr-xr-xexamples/session_patch.py4
5 files changed, 13 insertions, 5 deletions
diff --git a/examples/README.md b/examples/README.md
index 6645a4e..0102fd8 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -1,2 +1,3 @@
# Requests-Cache Examples
-This folder contains some complete examples for using the main features of requests-cache.
+This folder contains some complete examples that demonstrate the main features of requests-cache.
+These are also viewable on [readthedocs](https://requests-cache.readthedocs.io/en/latest/examples.html).
diff --git a/examples/basic_usage.py b/examples/basic_usage.py
index 5234e43..21651dc 100755
--- a/examples/basic_usage.py
+++ b/examples/basic_usage.py
@@ -1,6 +1,8 @@
#!/usr/bin/env python
# flake8: noqa: F841
-"""A Simple example using requests-cache with httpbin"""
+"""
+A simple example using requests-cache with httpbin
+"""
import time
from requests_cache import CachedSession
diff --git a/examples/convert_cache.py b/examples/convert_cache.py
index ce4f18f..a016bed 100755
--- a/examples/convert_cache.py
+++ b/examples/convert_cache.py
@@ -1,5 +1,6 @@
#!/usr/bin/env python
-"""Example of converting data cached in older versions of requests-cache (<=0.5.2)
+"""
+Example of converting data cached in older versions of requests-cache (<=0.5.2)
into the current format
"""
from requests import Response
diff --git a/examples/expiration.py b/examples/expiration.py
index 4afa5fa..942b198 100755
--- a/examples/expiration.py
+++ b/examples/expiration.py
@@ -1,5 +1,7 @@
#!/usr/bin/env python
-"""An example of setting expiration for individual requests"""
+"""
+An example of setting expiration for individual requests
+"""
import time
from requests_cache import CachedSession
diff --git a/examples/session_patch.py b/examples/session_patch.py
index f84e72e..4310687 100755
--- a/examples/session_patch.py
+++ b/examples/session_patch.py
@@ -1,6 +1,8 @@
#!/usr/bin/env python
# flake8: noqa: F841
-"""The same as `basic_usage.py`, but using global session patching"""
+"""
+The same as ``basic_usage.py``, but using global session patching
+"""
import time
import requests