Trivial: Change list.remove(x) documentation to better document the error raised #8636
Conversation
This file contains 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
…e an error is raised
Mariatta
approved these changes
Aug 3, 2018
|
Thanks @lysnikolaou for the PR, and @Mariatta for merging it 🌮🎉.. I'm working now to backport this PR to: 2.7, 3.6, 3.7. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Aug 3, 2018
Rephrase it to "It raises a `ValueError`" (cherry picked from commit bcd1d97) Co-authored-by: Lysandros Nikolaou <[email protected]>
|
GH-8641 is a backport of this pull request to the 3.7 branch. |
|
Sorry, @lysnikolaou and @Mariatta, I could not cleanly backport this to |
|
Sorry, @lysnikolaou and @Mariatta, I could not cleanly backport this to |
miss-islington
added a commit
that referenced
this pull request
Aug 3, 2018
Rephrase it to "It raises a `ValueError`" (cherry picked from commit bcd1d97) Co-authored-by: Lysandros Nikolaou <[email protected]>
|
Shouldn't the docstring be updated? See also |
|
Docstring documents the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I changed "It is an error" to "It raises a
ValueError", as I found it more suitable and more consistent to the documentations of the other methods.