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

Integrate the Type Stubs document into the spec #1605

Open
srittau opened this issue Jan 24, 2024 · 3 comments
Open

Integrate the Type Stubs document into the spec #1605

srittau opened this issue Jan 24, 2024 · 3 comments
Assignees
Labels
Typing Council decision Needs to be approved by the Typing Council. Do not merge until approved.

Comments

@srittau
Copy link
Collaborator

srittau commented Jan 24, 2024

The Type Stubs document (source/stubs.rst) is based on a proposed PEP by @rchen152, @JelleZijlstra, @Solumin, and myself to describe the allowed elements of type stubs. It was turned into kind of a proto-spec document, instead of a PEP. I haven't reviewed it in detail, but I think at least the "spec" parts of this document should be moved to the spec: chapters "Syntax" and "Supported Constructs". They might need updating, though. The "Distribution" chapter is mostly redundant with the spec anyway. The other chapters should probably moved to other documents, like "Writing and Maintaining Stub Files".

@srittau srittau added the Typing Council decision Needs to be approved by the Typing Council. Do not merge until approved. label Jan 24, 2024
@JelleZijlstra
Copy link
Member

Agree that the sections you flagged should be incorporated into the spec, with some updates.

For example, the "Syntax" section says stubs should follow 3.7 syntax, but 3.7 is dead now; we should instead say stubs should follow the syntax of the earliest Python version that is not EOL yet.

@rchen152
Copy link
Collaborator

I'd like to take a stab at this, if that's okay.

@erictraut
Copy link
Collaborator

Thanks for volunteering, @rchen152.

There's overlap between the Type Stubs document and the Typing Python Libraries document. I'd love to see these unified when this content is added to the typing spec.

rchen152 added a commit to rchen152/typing that referenced this issue Jul 24, 2024
This is part of an effort to integrate the standalone "Type Stubs" doc
into the rest of the typing documentation. See
python#1815 for more context.

For python#1605.
hauntsaninja pushed a commit that referenced this issue Jul 26, 2024
…bs. (#1817)

This is part of an effort to integrate the standalone "Type Stubs" doc
into the rest of the typing documentation. See
#1815 for more context.

For #1605.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Typing Council decision Needs to be approved by the Typing Council. Do not merge until approved.
Projects
None yet
Development

No branches or pull requests

4 participants