diff options
author | Chris Jerdonek <chris.jerdonek@gmail.com> | 2012-10-07 14:48:36 -0700 |
---|---|---|
committer | Chris Jerdonek <chris.jerdonek@gmail.com> | 2012-10-07 14:48:36 -0700 |
commit | 83fe2e1c22e6ff72a308e82e1e24ca03f8c51339 (patch) | |
tree | f8e8071faf6e7d06b812c8fa9090c41c57ad91d3 /Objects/longobject.c | |
parent | c3e5b10ae76c3ffe8672e91a5478a19e35b60220 (diff) | |
download | cpython-git-83fe2e1c22e6ff72a308e82e1e24ca03f8c51339.tar.gz |
Issue #14783: Improve int() docstring and also str(), range(), and slice().
This commit rewrites the docstring for int() to incorporate the documentation
changes made in issue #16036. It also switches the docstrings for int(),
str(), range(), and slice() to use multi-line signatures.
Diffstat (limited to 'Objects/longobject.c')
-rw-r--r-- | Objects/longobject.c | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/Objects/longobject.c b/Objects/longobject.c index dfedfb7bfe..b9a0d8543a 100644 --- a/Objects/longobject.c +++ b/Objects/longobject.c @@ -4703,13 +4703,20 @@ static PyGetSetDef long_getset[] = { }; PyDoc_STRVAR(long_doc, -"int(x[, base]) -> integer\n\ +"int(x=0) -> integer\n\ +int(x, base=10) -> integer\n\ \n\ -Convert a string or number to an integer, if possible. A floating\n\ -point argument will be truncated towards zero (this does not include a\n\ -string representation of a floating point number!) When converting a\n\ -string, use the optional base. It is an error to supply a base when\n\ -converting a non-string."); +Convert a number or string to an integer, or return 0 if no arguments\n\ +are given. If x is a number, return x.__int__(). For floating point\n\ +numbers, this truncates towards zero.\n\ +\n\ +If x is not a number or if base is given, then x must be a string,\n\ +bytes, or bytearray instance representing an integer literal in the\n\ +given base. The literal can be preceded by '+' or '-' and be surrounded\n\ +by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.\n\ +Base 0 means to interpret the base from the string as an integer literal.\n\ +>>> int('0b100', base=0)\n\ +4"); static PyNumberMethods long_as_number = { (binaryfunc)long_add, /*nb_add*/ |