Skip to content

Commit 7fcfecc

Browse files
Update README.md: suggest use of ~= syntax in readme. (#635)
1 parent 972bd87 commit 7fcfecc

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,12 @@ way as equivalent forms in `typing`.
2323
[Semantic Versioning](https://semver.org/). The
2424
major version will be incremented only for backwards-incompatible changes.
2525
Therefore, it's safe to depend
26-
on `typing_extensions` like this: `typing_extensions >=x.y, <(x+1)`,
26+
on `typing_extensions` like this: `typing_extensions ~=x.y`,
2727
where `x.y` is the first version that includes all features you need.
28+
[This](https://packaging.python.org/en/latest/specifications/version-specifiers/#compatible-release)
29+
is equivalent to `typing_extensions >=x.y, <(x+1)`. Do not depend on `~= x.y.z`
30+
unless you really know what you're doing; that defeats the purpose of
31+
semantic versioning.
2832

2933
## Included items
3034

0 commit comments

Comments
 (0)