actions/black
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

stub style: remove some possible future changes (#2940)

Browse Source 
Fixes #2938.

All of these suggested future changes are out of scope for an autoformatter and should be handled by a linter instead.
This commit is contained in:
Jelle Zijlstra 2022-03-21 15:20:41 -07:00 committed by GitHub
parent f87df0e3c8
commit 5379d4f3f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/the_black_code_style/current_style.md
View File

@ -399,16 +399,11 @@ recommended code style for those files is more terse than PEP 8:
_Black_ enforces the above rules. There are additional guidelines for formatting `.pyi` _Black_ enforces the above rules. There are additional guidelines for formatting `.pyi`
file that are not enforced yet but might be in a future version of the formatter: file that are not enforced yet but might be in a future version of the formatter:
- all function bodies should be empty (contain `...` instead of the body);
- do not use docstrings;
- prefer `...` over `pass`; - prefer `...` over `pass`;
- for arguments with a default, use `...` instead of the actual default;
- avoid using string literals in type annotations, stub files support forward references - avoid using string literals in type annotations, stub files support forward references
natively (like Python 3.7 code with `from __future__ import annotations`); natively (like Python 3.7 code with `from __future__ import annotations`);
- use variable annotations instead of type comments, even for stubs that target older - use variable annotations instead of type comments, even for stubs that target older
versions of Python; versions of Python.
- for arguments that default to `None`, use `Optional[]` explicitly;
- use `float` instead of `Union[int, float]`.
## Pragmatism ## Pragmatism