summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2018-01-25 21:47:45 -0800
committerBenjamin Peterson <benjamin@python.org>2018-01-25 21:47:45 -0800
commitedb7d0051202280d44939fd48863d244fe7b2c2b (patch)
treecf5b2bffc5be64b654afcce27f1225183f7f195d
parent877dbe88554fdd48455d00b51b2e728d59ef3436 (diff)
downloadsix-git-edb7d0051202280d44939fd48863d244fe7b2c2b.tar.gz
documentation tweaks
-rw-r--r--documentation/index.rst12
-rw-r--r--six.py6
2 files changed, 9 insertions, 9 deletions
diff --git a/documentation/index.rst b/documentation/index.rst
index 86c3a03..e86e3f8 100644
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -435,20 +435,20 @@ string data in all Python versions.
.. function:: ensure_binary(s, encoding='utf-8', errors='strict')
- A helper function to ensure output is :data:`binary_type`. ``encoding``, ``errors``
- are the same as :meth:`py3:str.encode`
+ Coerce *s* to :data:`binary_type`. *encoding*, *errors* are the same as
+ :meth:`py3:str.encode`
.. function:: ensure_str(s, encoding='utf-8', errors='strict')
- A helper function to ensure output is ``str``. ``encoding``, ``errors``
- are the same :meth:`py3:str.encode`
+ Coerce *s* to ``str``. ``encoding``, ``errors`` are the same
+ :meth:`py3:str.encode`
.. function:: ensure_text(s, encoding='utf-8', errors='strict')
- A helper function to ensure output is :data:`text_type`. ``encoding``, ``errors``
- are the same as :meth:`py3:str.encode`
+ Coerce *s* to :data:`text_type`. *encoding*, *errors* are the same as
+ :meth:`py3:str.encode`
.. data:: StringIO
diff --git a/six.py b/six.py
index 6ecf614..8d9ac41 100644
--- a/six.py
+++ b/six.py
@@ -849,7 +849,7 @@ def add_metaclass(metaclass):
def ensure_binary(s, encoding='utf-8', errors='strict'):
- """ A helper function to ensure output is six.binary_type.
+ """Coerce **s** to six.binary_type.
For Python 2:
- `unicode` -> encoded to `str`
@@ -868,7 +868,7 @@ def ensure_binary(s, encoding='utf-8', errors='strict'):
def ensure_str(s, encoding='utf-8', errors='strict'):
- """ A helper function to ensure output is `str`.
+ """Coerce *s* to `str`.
For Python 2:
- `unicode` -> encoded to `str`
@@ -888,7 +888,7 @@ def ensure_str(s, encoding='utf-8', errors='strict'):
def ensure_text(s, encoding='utf-8', errors='strict'):
- """ A helper function to ensure output is six.text_type.
+ """Coerce *s* to six.text_type.
For Python 2:
- `unicode` -> `unicode`