Prefer "similar" over "equivalent" in tutorial#125343
Merged
nedbat merged 1 commit intopython:mainfrom Oct 12, 2024
Merged
Conversation
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.
bedevere-app
bot
added
docs
Contributor
|
Maybe roughly equivalent is better? |
nedbat
added
skip issue
needs backport to 3.12
picnixz
reviewed
Oct 12, 2024
| :noindex: | ||
|
|
||
| Return a shallow copy of the list. Equivalent to ``a[:]``. | ||
| Return a shallow copy of the list. Similar to ``a[:]``. |
Member
There was a problem hiding this comment.
IIRC, this one is really equivalent but maybe I'm wrong. And many scripts use a[:] instead of .copy().
| :noindex: | ||
|
|
||
| Remove all items from the list. Equivalent to ``del a[:]``. | ||
| Remove all items from the list. Similar to ``del a[:]``. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Oct 12, 2024
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. (cherry picked from commit 4a2282b) Co-authored-by: Stephen Rosen <sirosen@globus.org>
|
GH-125372 is a backport of this pull request to the 3.13 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Oct 12, 2024
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. (cherry picked from commit 4a2282b) Co-authored-by: Stephen Rosen <sirosen@globus.org>
|
GH-125373 is a backport of this pull request to the 3.12 branch. |
willingc
pushed a commit
that referenced
this pull request
Oct 30, 2024
…-125372) Prefer "similar" over "equivalent" in tutorial (GH-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. (cherry picked from commit 4a2282b) Co-authored-by: Stephen Rosen <sirosen@globus.org>
willingc
pushed a commit
that referenced
this pull request
Oct 30, 2024
…-125373) Prefer "similar" over "equivalent" in tutorial (GH-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. (cherry picked from commit 4a2282b) Co-authored-by: Stephen Rosen <sirosen@globus.org>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In the datastructures tutorial doc, some operations are described as "equivalent to" others.
This has led to some user-confusion -- at least here 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.
Some thread participants in Discourse seem to want more changes to this doc.
I'm not against further changes, but in my view this change of wording is trivial and can be made as a first step.
📚 Documentation preview 📚: https://cpython-previews--125343.org.readthedocs.build/