diff options
| author | Eric Smith <eric@trueblade.com> | 2010-11-06 19:43:44 +0000 |
|---|---|---|
| committer | Eric Smith <eric@trueblade.com> | 2010-11-06 19:43:44 +0000 |
| commit | 6c84085cfba0fe420535caf86ed9b416e81e56d8 (patch) | |
| tree | 10e0145928f79b4439545bca2032caff0bce435b /Objects | |
| parent | 2f0a040dfed11f6c1e57bef0ad6eedbae7ce636b (diff) | |
| download | cpython-git-6c84085cfba0fe420535caf86ed9b416e81e56d8.tar.gz | |
Improved docstrings for str and unicode methods format and __format__.
Diffstat (limited to 'Objects')
| -rw-r--r-- | Objects/stringobject.c | 5 | ||||
| -rw-r--r-- | Objects/unicodeobject.c | 5 |
2 files changed, 6 insertions, 4 deletions
diff --git a/Objects/stringobject.c b/Objects/stringobject.c index 347f318338..6d3ca8eb82 100644 --- a/Objects/stringobject.c +++ b/Objects/stringobject.c @@ -3582,7 +3582,8 @@ string_getnewargs(PyStringObject *v) PyDoc_STRVAR(format__doc__, "S.format(*args, **kwargs) -> string\n\ \n\ -"); +Return a formatted version of S, using substitutions from args and kwargs.\n\ +The substitutions are identified by braces ('{' and '}')."); static PyObject * string__format__(PyObject* self, PyObject* args) @@ -3616,7 +3617,7 @@ done: PyDoc_STRVAR(p_format__doc__, "S.__format__(format_spec) -> string\n\ \n\ -"); +Return a formatted version of S as described by format_spec."); static PyMethodDef diff --git a/Objects/unicodeobject.c b/Objects/unicodeobject.c index 07b4e19795..1cd3688fa5 100644 --- a/Objects/unicodeobject.c +++ b/Objects/unicodeobject.c @@ -7728,7 +7728,8 @@ unicode_endswith(PyUnicodeObject *self, PyDoc_STRVAR(format__doc__, "S.format(*args, **kwargs) -> unicode\n\ \n\ -"); +Return a formatted version of S, using substitutions from args and kwargs.\n\ +The substitutions are identified by braces ('{' and '}')."); static PyObject * unicode__format__(PyObject *self, PyObject *args) @@ -7762,7 +7763,7 @@ unicode__format__(PyObject *self, PyObject *args) PyDoc_STRVAR(p_format__doc__, "S.__format__(format_spec) -> unicode\n\ \n\ -"); +Return a formatted version of S as described by format_spec."); static PyObject * unicode__sizeof__(PyUnicodeObject *v) |