-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Integrate stub coding style into PEP 8? #1688
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
Comments
As pointed out by @JelleZijlstra in #1687: A good first step would be to deduplicate/merge the sections in README.md and CONTRIBUTING.md. |
The typeshed has its own style guide, which is more relaxed than PEP 8. I don't think we should recommend this style to everyone writing stubs though, and I don't think we need more about type annotations or stubs in PEP 8 than there already is (there's a bit about formatting arguments that have both a type and a default). Feel free to help out by submitting a PR that does the suggested dedupe/merge! |
Into which document should we merge the coding style? My gut feeling says CONTRIBUTING.md. |
Yes.
|
Currently, both README.md and CONTRIBUTING.md contain (quite sensible) style guidelines for stub files. As third party modules can also ship their own stub files (even if support for that is still spotty), it makes sense to have guidelines for these as well. Are there any plans to integrate the guidelines into PEP 8? Should there be plans?
The text was updated successfully, but these errors were encountered: