Clarify Ellipsis usage in the docs (#683) #1631
Merged
Conversation
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
Member
|
I recommend removing the mention of Ellipsis; |
Contributor
Author
|
@gvanrossum your feedback slightly contradicts the open issue #683. So, I removed the comment about it being an option, but left the link to Ellipsis itself. |
Contributor
Author
|
I was expecting somebody to point to a section of the docs where it would make sense to add the explanation for the other use case. That is...
I can make an attempt in docs/type_inference_and_annotations.txt |
Member
|
The point here is to show clearly what one should write, not to be the
definitive reference. For that we have the PEP. Links to the formal
definitions of pass and Ellipsis feel out of place.
Sorry, maybe Jukka can be the final arbiter.
…--Guido (mobile)
|
Contributor
Author
|
That makes more sense to me, now. I've adjusted accordingly. I can squash whenever necessary. |
| class B(A): | ||
| def foo(self, x: int) -> None: ... | ||
| def bar(self -> str: | ||
| def bar(self) -> str: |
Contributor
Author
|
|
Contributor
Author
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Minor clarification and addition of links to the docs, just to close #683.
#683 could have probably been closed before this PR, but if somebody had a different idea of where this should go in the docs, I could modify this PR.
As rendered:
http://imgur.com/a/FSTpP