From: Nick Coghlan <ncoghlan@gmail.com>
Date: Thu, 16 Aug 2012 04:13:07 +0000 (+1000)
Subject: Fix str docstring
X-Git-Tag: v3.3.0rc1~100^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=573b1fd7794e01575736826300a6d3291818f2c4;p=python

Fix str docstring
---

diff --git a/Objects/unicodeobject.c b/Objects/unicodeobject.c
index d5ef87f909..b25b17b6a0 100644
--- a/Objects/unicodeobject.c
+++ b/Objects/unicodeobject.c
@@ -9963,11 +9963,15 @@ unicode_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
 }
 
 PyDoc_STRVAR(unicode_doc,
-             "str(string[, encoding[, errors]]) -> str\n\
+             "str(object[, encoding[, errors]]) -> str\n\
 \n\
-Create a new string object from the given encoded string.\n\
-encoding defaults to the current default string encoding.\n\
-errors can be 'strict', 'replace' or 'ignore' and defaults to 'strict'.");
+Create a new string object from the given object. If encoding or\n\
+errors is specified, then the object must expose a data buffer\n\
+that will be decoded using the given encoding and error handler.\n\
+Otherwise, returns the result of object.__str__() (if defined)\n\
+or repr(object).\n\
+encoding defaults to sys.getdefaultencoding().\n\
+errors defaults to 'strict'.");
 
 static PyObject *unicode_iter(PyObject *seq);