bpo-43698: do not use ... as argument name in docs
#30502
Merged
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
sobolevn
commented
Jan 9, 2022
| def visit_a(self, ...): | ||
| ... | ||
| ... | ||
| class MyVisitor: |
There was a problem hiding this comment.
This case is special. There was no class context defined. I've added it as well.
AlexWaygood
reviewed
Jan 9, 2022
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
kumaraditya303
requested changes
Jan 10, 2022
| @@ -186,15 +186,15 @@ The :mod:`abc` module also provides the following decorator: | |||
|
|
|||
| class C(ABC): | |||
| @abstractmethod | |||
| def my_abstract_method(self, ...): | |||
| def my_abstract_method(self, arg1): | |||
There was a problem hiding this comment.
Suggested change
| def my_abstract_method(self, arg1): | |
| def my_abstract_method(self, arg): |
There was a problem hiding this comment.
I've used explicitly different names to highlight that they are different.
merwok
approved these changes
Jan 18, 2022
raghavthind2005
approved these changes
Jan 22, 2022
|
GH-30917 is a backport of this pull request to the 3.10 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jan 26, 2022
(cherry picked from commit b9d8980) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
|
GH-30918 is a backport of this pull request to the 3.9 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jan 26, 2022
(cherry picked from commit b9d8980) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
miss-islington
added a commit
that referenced
this pull request
Jan 26, 2022
(cherry picked from commit b9d8980) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
miss-islington
added a commit
that referenced
this pull request
Jan 26, 2022
(cherry picked from commit b9d8980) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
hello-adam
pushed a commit
to hello-adam/cpython
that referenced
this pull request
Jun 2, 2022
(cherry picked from commit b9d8980) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
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.
Some people might think that
...is allowed as an argument name (or might think that it is some kind of special syntax like*or/). I believe that using valid syntax in our examples is better.So, now all examples with
...are refactored to use regular names. Now it will be easier to copy-paste examples for our users.https://bugs.python.org/issue43698
CC @corona10 as my mentor.