Skip to content

Commit

Permalink
rst format fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
andymccurdy committed Nov 15, 2018
1 parent 1a1559b commit 9b03af2
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,11 @@ MSET, MSETNX and ZADD
^^^^^^^^^^^^^^^^^^^^^

These commands all accept a mapping of key/value pairs. In redis-py 2.X
this mapping could be specified as \*args or as \**kwargs. Both of these styles
caused issues when Redis introduced optional flags to ZADD. Relying on \*args
caused issues with the optional argument order, especially in Python 2.7.
Relying on \**kwargs caused potential collision issues of user keys with the
argument names in the method signature.
this mapping could be specified as ``*args`` or as ``**kwargs``. Both of these
styles caused issues when Redis introduced optional flags to ZADD. Relying on
``*args`` caused issues with the optional argument order, especially in Python
2.7. Relying on ``**kwargs`` caused potential collision issues of user keys with
the argument names in the method signature.

To resolve this, redis-py 3.0 has changed these three commands to all accept
a single positional argument named mapping that is expected to be a dict.
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ def PyTest(x):
version=__version__,
description='Python client for Redis key-value store',
long_description=long_description,
long_description_content_type='text/x-rst',
url='https://github.com/andymccurdy/redis-py',
author='Andy McCurdy',
author_email='sedrik@gmail.com',
Expand Down

0 comments on commit 9b03af2

Please sign in to comment.