[Python-checkins] bpo-26701: Tweak the documentation for special methods in int(). (GH-6741)
Miss Islington (bot)
webhook-mailer at python.org
Thu May 10 10:38:10 EDT 2018
https://github.com/python/cpython/commit/22df4187c3882c6ec67180902e1151e65b03aee0
commit: 22df4187c3882c6ec67180902e1151e65b03aee0
branch: 3.7
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2018-05-10T07:38:06-07:00
summary:
bpo-26701: Tweak the documentation for special methods in int(). (GH-6741)
(cherry picked from commit df00f048250b9a07195b0e3b1c5c0161fdcc9db8)
Co-authored-by: Serhiy Storchaka <storchaka at gmail.com>
files:
M Doc/library/functions.rst
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 2d15001bffa7..3b05a3a4ed32 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -671,8 +671,8 @@ are always available. They are listed here in alphabetical order.
.. function:: hex(x)
Convert an integer number to a lowercase hexadecimal string prefixed with
- "0x". If x is not a Python :class:`int` object, it has to define an
- __index__() method that returns an integer. Some examples:
+ "0x". If *x* is not a Python :class:`int` object, it has to define an
+ :meth:`__index__` method that returns an integer. Some examples:
>>> hex(255)
'0xff'
@@ -730,12 +730,10 @@ are always available. They are listed here in alphabetical order.
int(x, base=10)
Return an integer object constructed from a number or string *x*, or return
- ``0`` if no arguments are given. If *x* is a number, return
- :meth:`x.__int__() <object.__int__>`. If *x* defines
- :meth:`x.__trunc__() <object.__trunc__>` but not
- :meth:`x.__int__() <object.__int__>`, then return
- :meth:`x.__trunc__() <object.__trunc__>`. For floating point numbers,
- this truncates towards zero.
+ ``0`` if no arguments are given. If *x* defines :meth:`__int__`,
+ ``int(x)`` returns ``x.__int__()``. If *x* defines :meth:`__trunc__`,
+ it returns ``x.__trunc__()``.
+ For floating point numbers, this truncates towards zero.
If *x* is not a number or if *base* is given, then *x* must be a string,
:class:`bytes`, or :class:`bytearray` instance representing an :ref:`integer
More information about the Python-checkins
mailing list