VimPlug/typeshed
1
0
Fork 0
mirror of https://github.com/davidhalter/typeshed.git synced 2025-12-06 12:14:27 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add a convention for platform-dependent APIs to CONTRIBUTING.md (#2281)

Browse Source
This commit is contained in:
Yusuke Miyazaki
2018-06-27 01:14:12 +09:00
committed by Jelle Zijlstra
parent de1755b263
commit b91cb87249
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@@ -211,7 +211,9 @@ Some further tips for good type hints:
positions, in favor of covariant types like `Mapping` or `Sequence`;
* avoid Union return types: https://github.com/python/mypy/issues/1693;
* in Python 2, whenever possible, use `unicode` if that's the only
possible type, and `Text` if it can be either `unicode` or `bytes`.
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.
Imports in stubs are considered private (not part of the exported API)
unless: