summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorXiang Zhang <angwerzx@126.com>2017-03-13 02:09:16 (GMT)
committerGitHub <noreply@github.com>2017-03-13 02:09:16 (GMT)
commitb2d77175d1317494b4238b4e07426d310fbf1d19 (patch)
treed733ada08a354222ceecc227c2e8e560fa203c00
parent004251059b9c5e48d47cb30b94bcb92cb44d3adf (diff)
downloadcpython-b2d77175d1317494b4238b4e07426d310fbf1d19.zip
cpython-b2d77175d1317494b4238b4e07426d310fbf1d19.tar.gz
cpython-b2d77175d1317494b4238b4e07426d310fbf1d19.tar.bz2
bpo-29756: Improve documentation for list methods that compare items by equality (GH-572)
-rw-r--r--Doc/library/stdtypes.rst2
-rw-r--r--Doc/tutorial/datastructures.rst4
2 files changed, 3 insertions, 3 deletions
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index 4433312..9cf8767 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -1084,7 +1084,7 @@ accepts integers that meet the value restriction ``0 <= x <= 255``).
| | also removes it from *s* | |
+------------------------------+--------------------------------+---------------------+
| ``s.remove(x)`` | remove the first item from *s* | \(3) |
-| | where ``s[i] == x`` | |
+| | where ``s[i]`` is equal to *x* | |
+------------------------------+--------------------------------+---------------------+
| ``s.reverse()`` | reverses the items of *s* in | \(4) |
| | place | |
diff --git a/Doc/tutorial/datastructures.rst b/Doc/tutorial/datastructures.rst
index 6140ece..74a1ee7 100644
--- a/Doc/tutorial/datastructures.rst
+++ b/Doc/tutorial/datastructures.rst
@@ -40,7 +40,7 @@ objects:
.. method:: list.remove(x)
:noindex:
- Remove the first item from the list whose value is *x*. It is an error if
+ Remove the first item from the list whose value is equal to *x*. It is an error if
there is no such item.
@@ -63,7 +63,7 @@ objects:
.. method:: list.index(x[, start[, end]])
:noindex:
- Return zero-based index in the list of the first item whose value is *x*.
+ Return zero-based index in the list of the first item whose value is equal to *x*.
Raises a :exc:`ValueError` if there is no such item.
The optional arguments *start* and *end* are interpreted as in the slice