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.

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

Make library guidelines checker agnostic #934

Merged
merged 5 commits into from
Nov 12, 2021

Conversation

Bibo-Joshi
Copy link
Contributor

Hi. This PR is a spin-off of #913. Citing:

Moreover, because the guideline was copied as-is from pyright, it strongly emphasizes pyright as typechecker, which I also wouldn't expect from a python source. For comparison: the docs of the typing module which are somewhat longer than these guidelines mention "e.g., via mypy or Pyre" exactly once.

Hence, this PR tries to make guidelines more agnostic of the used type checker. It also tries to emphasize that the guidelines are not (yet) fixed rules, but in fact guidelines - which at least is my understanding of what the document is supposed to represent.

@erictraut
Copy link
Collaborator

These changes look good to me. Thanks @Bibo-Joshi.

@hauntsaninja hauntsaninja merged commit 1118e9d into python:master Nov 12, 2021
@Bibo-Joshi Bibo-Joshi deleted the checker-agnostig-guidelines branch November 12, 2021 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants