Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Recommend Self in CONTRIBUTING.md #5699

Merged
merged 4 commits into from
Jun 27, 2021
Merged

Recommend Self in CONTRIBUTING.md #5699

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9b69683
Recommend `Self` in CONTRIBUTING.md
JelleZijlstra Jun 27, 2021
fc4746c
put it next to `__exit__` guidelines
JelleZijlstra Jun 27, 2021
d4f857e
change example pr
Akuli Jun 27, 2021
52221ed
blank line
JelleZijlstra Jun 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,9 @@ Some further tips for good type hints:
possible type, and `Text` if it can be either `unicode` or `bytes`;
* use platform checks like `if sys.platform == 'win32'` to denote
platform-dependent APIs.
* `__enter__` methods and other methods that return instances of the
current class should be annotated with the `_typeshed.Self` type
variable ([example](https://github.com/python/typeshed/pull/5689)).

Imports in stubs are considered private (not part of the exported API)
unless:
Expand Down