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

[spec] Update typeshed language to conform to reality #1571

Merged
merged 3 commits into from
Jan 12, 2024

Conversation

srittau
Copy link
Collaborator

@srittau srittau commented Jan 10, 2024

  • Describe typeshed as a "project", not a "repository".
  • While typeshed still contains third-party stubs, those are usually not distributed with type checkers, but available from PyPI. Update the language accordingly.
  • This also means that step 5 of the import resolution ordering should reference the stdlib only.
  • Fix the reference to another section.
  • Fix typo in section name.

* Describe typeshed as a "project", not a "repository".
* While typeshed still contains third-party stubs, those are usually not distributed with type checkers, but available from PyPI. Update the language accordingly.
* This also means that step 5 of the import resolution ordering should reference the stdlib only.
* Fix the reference to another section.
* Fix typo in section name.
@srittau srittau added the Typing Council decision Needs to be approved by the Typing Council. Do not merge until approved. label Jan 10, 2024
Copy link
Member

@JelleZijlstra JelleZijlstra left a comment

Choose a reason for hiding this comment

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

Thanks! Let's leave this open for a few days in case other Council members have a different opinion (cc @hauntsaninja @gvanrossum @rchen152), but I don't think this needs to go through the formal decision-making procedure.

There is one typeshed-related issue that maybe we should add to the spec: the format of the VERSIONS file. I think that's important to specify because it affects type checker interoperability. However, that should be discussed separately.

Copy link
Collaborator

@rchen152 rchen152 left a comment

Choose a reason for hiding this comment

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

These all look like good changes to me.

Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

LG, one wordsmithing nit.

docs/spec/distributing.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@hauntsaninja hauntsaninja left a comment

Choose a reason for hiding this comment

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

Thank you, had some wording nits to try to more clearly disambiguate the two roles typeshed plays

docs/spec/distributing.rst Outdated Show resolved Hide resolved
docs/spec/distributing.rst Outdated Show resolved Hide resolved
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
@hauntsaninja hauntsaninja merged commit 606fef4 into python:main Jan 12, 2024
3 checks passed
@srittau srittau deleted the spec-typeshed branch January 12, 2024 09:01
hauntsaninja added a commit to hauntsaninja/typing that referenced this pull request Jan 16, 2024
* Describe typeshed as a "project", not a "repository".
* While typeshed still contains third-party stubs, those are usually not distributed with type checkers, but available from PyPI. Update the language accordingly.
* This also means that step 5 of the import resolution ordering should reference the stdlib only.

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
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

Successfully merging this pull request may close these issues.

6 participants