summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornsantiago2719 <nsantiago2719@gmail.com>2017-08-25 15:28:21 +0800
committernsantiago2719 <nsantiago2719@gmail.com>2017-08-25 15:28:21 +0800
commitc8e61b3efdf0f9400fa27803e36094e24a99fc43 (patch)
tree9b7eb29738d6f1f7438388debdf889be78170550
parent23de82967c7424a5923c45170785216cea29feea (diff)
downloadredis-py-c8e61b3efdf0f9400fa27803e36094e24a99fc43.tar.gz
clarified the documentation
-rw-r--r--README.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index c05a2da..f77c040 100644
--- a/README.rst
+++ b/README.rst
@@ -37,12 +37,15 @@ Getting Started
.. code-block:: pycon
>>> import redis
- >>> r = redis.StrictRedis(host='localhost', port=6379, db=0) #Add `decode_responses=True` if you are using Python 3
+ >>> r = redis.StrictRedis(host='localhost', port=6379, db=0)
>>> r.set('foo', 'bar')
True
>>> r.get('foo')
'bar'
+By default, the value returned if you are using Python3 are in raw byte strings.
+If you want a decoded response you can add `decode_response=True` in `redis.StrictRedis()`.
+
API Reference
-------------