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

Remove stub content/style section from CONTRIBUTING.md #13332

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

yangdanny97
Copy link
Contributor

python/typing#1882 has added the stub content/style guidelines from CONTRIBUTING.md to the official typing documentation (https://typing.readthedocs.io/en/latest/guides/writing_stubs.html), so we can change the contributing guide to link to that directly.

I added a special note re: omitting docstrings from typeshed, since the official docs only discusses tradeoffs (per Jelle's recommendation in python/typing#1880 (comment))

@yangdanny97 yangdanny97 marked this pull request as ready for review December 29, 2024 01:54
@Avasam
Copy link
Collaborator

Avasam commented Dec 29, 2024

This reminds me of an old PR by @srittau and reviewed by @JelleZijlstra that went unmerged https://github.com/python/typeshed/pull/7594/files
I haven't gone through the whole thing yet, I'm just wondering if there's more sections that can be updated with a link.

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

Successfully merging this pull request may close these issues.

2 participants