Skip to content

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

Closed
srittau opened this issue Oct 26, 2017 · 4 comments
Closed

Integrate stub coding style into PEP 8? #1688

srittau opened this issue Oct 26, 2017 · 4 comments

Comments

@srittau
Copy link
Collaborator

srittau commented Oct 26, 2017

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?

@srittau
Copy link
Collaborator Author

srittau commented Oct 26, 2017

As pointed out by @JelleZijlstra in #1687: A good first step would be to deduplicate/merge the sections in README.md and CONTRIBUTING.md.

@gvanrossum
Copy link
Member

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!

@srittau
Copy link
Collaborator Author

srittau commented Oct 27, 2017

Into which document should we merge the coding style? My gut feeling says CONTRIBUTING.md.

@gvanrossum
Copy link
Member

gvanrossum commented Oct 27, 2017 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants