Skip to content

Commit 37b94d2

Browse files
committed
Add to list of shadowed builtins.
1 parent a5a06ad commit 37b94d2

3 files changed

Lines changed: 12 additions & 10 deletions

File tree

README.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,10 @@ For demonstration purposes, start with::
5555

5656
>>> from bigfloat import *
5757

58-
Note that this import shadows five builtin Python functions, namely ``abs``,
59-
``max``, ``min``, ``pow`` and ``round``. In normal usage you'll probably only
60-
want to import the classes and functions that you actually need.
58+
Note that this import shadows some builtin Python functions, namely ``abs``,
59+
``max``, ``min``, ``pow``, ``round`` and (on Python 2 only) ``cmp``. In normal
60+
usage you'll probably only want to import the classes and functions that you
61+
actually need.
6162

6263
The main class is the ``BigFloat`` class::
6364

docs/source/tutorial/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ Start by importing the contents of the package with:
88
>>> from bigfloat import *
99

1010
You should be a little bit careful here: this import brings a fairly large
11-
number of functions into the current namespace, five of which shadow existing
12-
Python builtins, namely :func:`abs`, :func:`max`, :func:`min`, :func:`pow` and
13-
:func:`round`. In normal usage you'll probably only want to import the classes
14-
and functions that you actually need.
11+
number of functions into the current namespace, some of which shadow existing
12+
Python builtins, namely :func:`abs`, :func:`max`, :func:`min`, :func:`pow`,
13+
:func:`round`, and (on Python 2 only) :func:`cmp`. In normal usage you'll
14+
probably only want to import the classes and functions that you actually need.
1515

1616

1717
:class:`BigFloat` construction

setup.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,10 @@
7676
7777
>>> from bigfloat import *
7878
79-
Note that this import shadows five builtin Python functions, namely ``abs``,
80-
``max``, ``min``, ``pow`` and ``round``. In normal usage you'll probably only
81-
want to import the classes and functions that you actually need.
79+
Note that this import shadows some builtin Python functions, namely ``abs``,
80+
``max``, ``min``, ``pow``, ``round`` and (on Python 2 only) ``cmp``. In normal
81+
usage you'll probably only want to import the classes and functions that you
82+
actually need.
8283
8384
The main class is the ``BigFloat`` class::
8485

0 commit comments

Comments
 (0)