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.

@yangdanny97
Copy link
Contributor Author

The only extra thing that PR deletes is the "Supported type system features" section. The comments mentioned linking to the issue tracker: project: feature tracker Tracks whether a typing feature can be used in typeshed stubs , but I don't quite understand @AlexWaygood 's comment

We could also consider using a meta-issue tracker to track the issue trackers.

Perhaps we can do that in a separate PR?

@Akuli
Copy link
Collaborator

Akuli commented Jan 5, 2025

I don't think this is a good idea.

I think CONTRIBUTING.md should be a self-contained document that you read, and then you can contribute. It should be as painless as possible to go through, so it shouldn't expect readers to follow links and read something elsewhere.

That said, "for more info see also" type of links are ok in a CONTRIBUTING.md.

it's not possible to accurately type an item using the current type system.
It should be used sparingly.

### "The `Any` trick"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the Any trick is a good example of a "for more info, see also" kind of thing. Most contributors won't need to know about it, so it is IMO a good idea to link to it from CONTRIBUTING.md, but not explain it here.

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.

3 participants