mirror of https://github.com/python/cpython
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.
This commit is contained in:
parent
c3e5b10ae7
commit
83fe2e1c22
|
@ -1236,7 +1236,8 @@ are always available. They are listed here in alphabetical order.
|
||||||
standard type hierarchy in :ref:`types`.
|
standard type hierarchy in :ref:`types`.
|
||||||
|
|
||||||
|
|
||||||
.. function:: str([object[, encoding[, errors]]])
|
.. function:: str(object='')
|
||||||
|
str(object[, encoding[, errors]])
|
||||||
|
|
||||||
Return a string version of an object, using one of the following modes:
|
Return a string version of an object, using one of the following modes:
|
||||||
|
|
||||||
|
|
|
@ -10,6 +10,9 @@ What's New in Python 3.2.4
|
||||||
Core and Builtins
|
Core and Builtins
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
|
- Issue #14783: Improve int() docstring and switch docstrings for str(),
|
||||||
|
range(), and slice() to use multi-line signatures.
|
||||||
|
|
||||||
- Issue #15379: Fix passing of non-BMP characters as integers for the charmap
|
- Issue #15379: Fix passing of non-BMP characters as integers for the charmap
|
||||||
decoder (already working as unicode strings). Patch by Serhiy Storchaka.
|
decoder (already working as unicode strings). Patch by Serhiy Storchaka.
|
||||||
|
|
||||||
|
|
|
@ -4703,13 +4703,20 @@ static PyGetSetDef long_getset[] = {
|
||||||
};
|
};
|
||||||
|
|
||||||
PyDoc_STRVAR(long_doc,
|
PyDoc_STRVAR(long_doc,
|
||||||
"int(x[, base]) -> integer\n\
|
"int(x=0) -> integer\n\
|
||||||
|
int(x, base=10) -> integer\n\
|
||||||
\n\
|
\n\
|
||||||
Convert a string or number to an integer, if possible. A floating\n\
|
Convert a number or string to an integer, or return 0 if no arguments\n\
|
||||||
point argument will be truncated towards zero (this does not include a\n\
|
are given. If x is a number, return x.__int__(). For floating point\n\
|
||||||
string representation of a floating point number!) When converting a\n\
|
numbers, this truncates towards zero.\n\
|
||||||
string, use the optional base. It is an error to supply a base when\n\
|
\n\
|
||||||
converting a non-string.");
|
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 = {
|
static PyNumberMethods long_as_number = {
|
||||||
(binaryfunc)long_add, /*nb_add*/
|
(binaryfunc)long_add, /*nb_add*/
|
||||||
|
|
|
@ -135,7 +135,8 @@ range_new(PyTypeObject *type, PyObject *args, PyObject *kw)
|
||||||
}
|
}
|
||||||
|
|
||||||
PyDoc_STRVAR(range_doc,
|
PyDoc_STRVAR(range_doc,
|
||||||
"range([start,] stop[, step]) -> range object\n\
|
"range(stop) -> range object\n\
|
||||||
|
range(start, stop[, step]) -> range object\n\
|
||||||
\n\
|
\n\
|
||||||
Returns a virtual sequence of numbers from start to stop by step.");
|
Returns a virtual sequence of numbers from start to stop by step.");
|
||||||
|
|
||||||
|
|
|
@ -221,7 +221,8 @@ slice_new(PyTypeObject *type, PyObject *args, PyObject *kw)
|
||||||
}
|
}
|
||||||
|
|
||||||
PyDoc_STRVAR(slice_doc,
|
PyDoc_STRVAR(slice_doc,
|
||||||
"slice([start,] stop[, step])\n\
|
"slice(stop)\n\
|
||||||
|
slice(start, stop[, step])\n\
|
||||||
\n\
|
\n\
|
||||||
Create a slice object. This is used for extended slicing (e.g. a[0:10:2]).");
|
Create a slice object. This is used for extended slicing (e.g. a[0:10:2]).");
|
||||||
|
|
||||||
|
|
|
@ -9986,7 +9986,8 @@ unicode_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
|
||||||
}
|
}
|
||||||
|
|
||||||
PyDoc_STRVAR(unicode_doc,
|
PyDoc_STRVAR(unicode_doc,
|
||||||
"str(object[, encoding[, errors]]) -> str\n\
|
"str(object='') -> str\n\
|
||||||
|
str(bytes_or_buffer[, encoding[, errors]]) -> str\n\
|
||||||
\n\
|
\n\
|
||||||
Create a new string object from the given object. If encoding or\n\
|
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\
|
errors is specified, then the object must expose a data buffer\n\
|
||||||
|
|
Loading…
Reference in New Issue