-
Notifications
You must be signed in to change notification settings - Fork 249
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: Add "meta" file describing process for changing the spec #1573
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
Meta-topics | ||
=========== | ||
|
||
About this specification | ||
------------------------ | ||
|
||
This document was created following the acceptance of :pep:`729` | ||
to serve as a specification for the Python type system. The | ||
initial text consists of the "Specification" sections of :pep:`484` | ||
and subsequent typing-related PEPs, pasted together and reorganized. | ||
This creates a document that encompasses all aspects of the type | ||
system that have been specified in PEPs, but not necessarily a | ||
coherent whole. The hope is that incremental improvements will | ||
be made to this document to make it more coherent and complete. | ||
|
||
Changing the specification | ||
-------------------------- | ||
|
||
Changes to the specification come in three kinds: | ||
|
||
- Minor, non-substantive changes can simply be proposed as PRs to | ||
the `python/typing <https://github.com/python/typing>`__ repository, | ||
and may be merged by anyone with commit access. Such changes may | ||
include formatting fixes, linking improvements, etc. | ||
- Major changes should go through the PEP process, as described in | ||
:pep:`1`. What counts as a major change is not precisely defined, | ||
but it would generally include any change of a similar magnitude | ||
to `previous typing PEPs <https://peps.python.org/topic/typing/>`__. | ||
- Substantive changes that do not rise to the level of a PEP must | ||
be approved by the Typing Council. The procedure is described below. | ||
|
||
Changes that need Typing Council approval go through three steps: | ||
|
||
- Open a discussion on `discuss.python.org <https://discuss.python.org/c/typing/32>`__ | ||
describing the issue. | ||
- Open a PR on `python/typing <https://github.com/python/typing>`__ | ||
that changes the spec and the `conformance test suite <https://github.com/python/typing/tree/main/conformance>`__. | ||
- `Open an issue <https://github.com/python/typing-council/issues/new>`__ on | ||
the Typing Council's issue tracker asking for a decision. | ||
|
||
The Typing Council has `published <https://github.com/python/typing-council/blob/main/README.md>`__ | ||
some guidance on useful information to gather when proposing a change | ||
to the spec, including: | ||
|
||
- A survey of the current behavior of major type checkers. | ||
- A rationale for why the proposed behavior is better than alternatives. | ||
- An implementation or proposed implementation of the proposed behavior | ||
in at least one major type checker. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The ordering here is a bit weird -- it feels like counting 1, 3, 2.
I noticed because there's a gray area between minor and substantive where the TC needs to approve but no conformance test suite changes are needed (e.g. because we're merely confirming that what happens to work is in fact meant to work rather than undefined behavior where the current crop of checkers all happen to agree).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right, I will reorder the list. (I had a reason for this order but it's not worth the confusion.)