Skip to content

Commit

Permalink
stub style: remove some possible future changes (#2940)
Browse files Browse the repository at this point in the history
Fixes #2938.

All of these suggested future changes are out of scope for an autoformatter and should be handled by a linter instead.
  • Loading branch information
JelleZijlstra committed Mar 21, 2022
1 parent f87df0e commit 5379d4f
Showing 1 changed file with 1 addition and 6 deletions.
7 changes: 1 addition & 6 deletions docs/the_black_code_style/current_style.md
Expand Up @@ -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`
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`;
- for arguments with a default, use `...` instead of the actual default;
- avoid using string literals in type annotations, stub files support forward references
natively (like Python 3.7 code with `from __future__ import annotations`);
- use variable annotations instead of type comments, even for stubs that target older
versions of Python;
- for arguments that default to `None`, use `Optional[]` explicitly;
- use `float` instead of `Union[int, float]`.
versions of Python.

## Pragmatism

Expand Down

0 comments on commit 5379d4f

Please sign in to comment.