Skip to content

Commit 0b15a3c

Browse files
Add PEP links to README (#92)
1 parent 0dc7304 commit 0b15a3c

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -35,48 +35,48 @@ This module currently contains the following:
3535

3636
- Experimental features
3737

38-
- `override` (see PEP 698)
39-
- The `default=` argument to `TypeVar`, `ParamSpec`, and `TypeVarTuple` (see PEP 696)
40-
- The `infer_variance=` argument to `TypeVar` (see PEP 695)
38+
- `override` (see [PEP 698](https://peps.python.org/pep-0698/))
39+
- The `default=` argument to `TypeVar`, `ParamSpec`, and `TypeVarTuple` (see [PEP 696](https://peps.python.org/pep-0696/))
40+
- The `infer_variance=` argument to `TypeVar` (see [PEP 695](https://peps.python.org/pep-0695/))
4141

4242
- In `typing` since Python 3.11
4343

4444
- `assert_never`
4545
- `assert_type`
4646
- `clear_overloads`
47-
- `@dataclass_transform()` (see PEP 681)
47+
- `@dataclass_transform()` (see [PEP 681](https://peps.python.org/pep-0681/))
4848
- `get_overloads`
49-
- `LiteralString` (see PEP 675)
49+
- `LiteralString` (see [PEP 675](https://peps.python.org/pep-0675/))
5050
- `Never`
51-
- `NotRequired` (see PEP 655)
51+
- `NotRequired` (see [PEP 655](https://peps.python.org/pep-0655/))
5252
- `reveal_type`
53-
- `Required` (see PEP 655)
54-
- `Self` (see PEP 673)
55-
- `TypeVarTuple` (see PEP 646; the `typing_extensions` version supports the `default=` argument from PEP 696)
56-
- `Unpack` (see PEP 646)
53+
- `Required` (see [PEP 655](https://peps.python.org/pep-0655/))
54+
- `Self` (see [PEP 673](https://peps.python.org/pep-0673/))
55+
- `TypeVarTuple` (see [PEP 646](https://peps.python.org/pep-0646/); the `typing_extensions` version supports the `default=` argument from [PEP 696](https://peps.python.org/pep-0696/))
56+
- `Unpack` (see [PEP 646](https://peps.python.org/pep-0646/))
5757

5858
- In `typing` since Python 3.10
5959

60-
- `Concatenate` (see PEP 612)
61-
- `ParamSpec` (see PEP 612; the `typing_extensions` version supports the `default=` argument from PEP 696)
62-
- `ParamSpecArgs` (see PEP 612)
63-
- `ParamSpecKwargs` (see PEP 612)
64-
- `TypeAlias` (see PEP 613)
65-
- `TypeGuard` (see PEP 647)
60+
- `Concatenate` (see [PEP 612](https://peps.python.org/pep-0612/))
61+
- `ParamSpec` (see [PEP 612](https://peps.python.org/pep-0612/); the `typing_extensions` version supports the `default=` argument from [PEP 696](https://peps.python.org/pep-0696/))
62+
- `ParamSpecArgs` (see [PEP 612](https://peps.python.org/pep-0612/))
63+
- `ParamSpecKwargs` (see [PEP 612](https://peps.python.org/pep-0612/))
64+
- `TypeAlias` (see [PEP 613](https://peps.python.org/pep-0613/))
65+
- `TypeGuard` (see [PEP 647](https://peps.python.org/pep-0647/))
6666
- `is_typeddict`
6767

6868
- In `typing` since Python 3.9
6969

70-
- `Annotated` (see PEP 593)
70+
- `Annotated` (see [PEP 593](https://peps.python.org/pep-0593/))
7171

7272
- In `typing` since Python 3.8
7373

74-
- `final` (see PEP 591)
75-
- `Final` (see PEP 591)
76-
- `Literal` (see PEP 586)
77-
- `Protocol` (see PEP 544)
78-
- `runtime_checkable` (see PEP 544)
79-
- `TypedDict` (see PEP 589)
74+
- `final` (see [PEP 591](https://peps.python.org/pep-0591/))
75+
- `Final` (see [PEP 591](https://peps.python.org/pep-0591/))
76+
- `Literal` (see [PEP 586](https://peps.python.org/pep-0586/))
77+
- `Protocol` (see [PEP 544](https://peps.python.org/pep-0544/))
78+
- `runtime_checkable` (see [PEP 544](https://peps.python.org/pep-0544/))
79+
- `TypedDict` (see [PEP 589](https://peps.python.org/pep-0589/))
8080
- `get_origin` (`typing_extensions` provides this function only in Python 3.7+)
8181
- `get_args` (`typing_extensions` provides this function only in Python 3.7+)
8282

@@ -92,7 +92,7 @@ This module currently contains the following:
9292
- `AsyncIterator`
9393
- `Awaitable`
9494
- `ChainMap`
95-
- `ClassVar` (see PEP 526)
95+
- `ClassVar` (see [PEP 526](https://peps.python.org/pep-0526/))
9696
- `ContextManager`
9797
- `Coroutine`
9898
- `Counter`
@@ -111,7 +111,7 @@ This module currently contains the following:
111111

112112
- `Any` (supports inheritance since Python 3.11)
113113
- `NamedTuple` (supports multiple inheritance with `Generic` since Python 3.11)
114-
- `TypeVar` (see PEPs 695 and 696)
114+
- `TypeVar` (see PEPs [695](https://peps.python.org/pep-0695/) and [696](https://peps.python.org/pep-0696/))
115115

116116
# Other Notes and Limitations
117117

@@ -136,7 +136,7 @@ Certain objects were changed after they were added to `typing`, and
136136
- Since Python 3.11, it has been possible to inherit from `Any` at
137137
runtime. `typing_extensions.Any` also provides this capability.
138138
- `TypeVar` gains two additional parameters, `default=` and `infer_variance=`,
139-
in the draft PEPs 695 and 696, which are being considered for inclusion
139+
in the draft PEPs [695](https://peps.python.org/pep-0695/) and [696](https://peps.python.org/pep-0696/), which are being considered for inclusion
140140
in Python 3.12.
141141

142142
There are a few types whose interface was modified between different
@@ -150,12 +150,12 @@ Certain types have incorrect runtime behavior due to limitations of older
150150
versions of the typing module:
151151

152152
- `ParamSpec` and `Concatenate` will not work with `get_args` and
153-
`get_origin`. Certain PEP 612 special cases in user-defined
153+
`get_origin`. Certain [PEP 612](https://peps.python.org/pep-0612/) special cases in user-defined
154154
`Generic`s are also not available.
155155

156156
These types are only guaranteed to work for static type checking.
157157

158158
## Running tests
159159

160160
To run tests, navigate into the appropriate source directory and run
161-
`test_typing_extensions.py`.
161+
`test_typing_extensions.py`.

0 commit comments

Comments
 (0)