Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Prefer "similar" over "equivalent" in tutorial (#125343) 

In the datastructures tutorial doc, some operations are described as
"equivalent to" others. This has led to some user-confusion -- at
least in the Discourse forums -- about cases in which the operations
differ.

This change doesn't systematically eliminate the word "equivalent"
from the tutorial. It just substitutes "similar to" in several cases
in which "equivalent to" could mislead users into expecting exact
equivalence.
This commit is contained in:
Stephen Rosen 2024-10-12 15:21:55 -05:00 committed by GitHub
parent 62d5a53a0b
commit 4a2282b067
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Doc/tutorial/datastructures.rst
View File

@ -19,13 +19,13 @@ objects:
.. method:: list.append(x)
:noindex:
Add an item to the end of the list. Equivalent to ``a[len(a):] = [x]``.
Add an item to the end of the list. Similar to ``a[len(a):] = [x]``.
.. method:: list.extend(iterable)
:noindex:
Extend the list by appending all the items from the iterable. Equivalent to
Extend the list by appending all the items from the iterable. Similar to
``a[len(a):] = iterable``.
@ -56,7 +56,7 @@ objects:
.. method:: list.clear()
:noindex:
Remove all items from the list. Equivalent to ``del a[:]``.
Remove all items from the list. Similar to ``del a[:]``.
.. method:: list.index(x[, start[, end]])
@ -93,7 +93,7 @@ objects:
.. method:: list.copy()
:noindex:
Return a shallow copy of the list. Equivalent to ``a[:]``.
Return a shallow copy of the list. Similar to ``a[:]``.
An example that uses most of the list methods::