Commit 26d261a
docs: replace "Nothing breaks." with a check the reader can run
The claim was contradicted by the 2.0 removals list. Worse, it was
unfalsifiable -- it gave a reader no way to find out whether their own
code was affected.
Replace it with the actual promise: if your suite runs clean on 1.4
under -W error::DeprecationWarning, it runs on 2.0. Verified against a
live 1.4.0 -- 11 of the 15 removals do warn there.
Name the four that do not, in a new "Before you upgrade" section:
regexes assignment (including the CONSTANTS.regexes.bidi = False recipe
1.3.1 itself recommended), *_list assignment, positional Constants(),
and subclass parsing-hook overrides. All four raise or warn on contact,
so the reader meets them immediately.
Call out separately the one removal that changes results in silence:
HumanName.__eq__ is gone, so name == "John Smith" is now False. It
warned on 1.4 and says nothing on 2.0, making it the only way to get a
wrong answer without being told.
Also drop "or never" from the migration framing -- the compatibility
layer is removed in 3.0, as the next sentence says.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>1 parent 24aa787 commit 26d261a
2 files changed
Lines changed: 42 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
47 | | - | |
48 | | - | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
49 | 54 | | |
50 | | - | |
51 | | - | |
| 55 | + | |
| 56 | + | |
52 | 57 | | |
53 | 58 | | |
54 | 59 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
5 | | - | |
6 | | - | |
7 | | - | |
8 | | - | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
9 | 8 | | |
10 | | - | |
| 9 | + | |
11 | 10 | | |
12 | 11 | | |
13 | 12 | | |
| |||
19 | 18 | | |
20 | 19 | | |
21 | 20 | | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
22 | 49 | | |
23 | 50 | | |
24 | 51 | | |
| |||
0 commit comments