Skip to content

[3.6] bpo-26701: Tweak the documentation for special methods in int(). (GH-6741) #6752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 10, 2018
Merged

[3.6] bpo-26701: Tweak the documentation for special methods in int(). (GH-6741) #6752

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions Doc/library/functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -657,8 +657,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'
Expand Down Expand Up @@ -716,12 +716,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
Expand Down