Commit 3edfe4e
docs: move stranded recipes out of the release log
Actionable knowledge had accumulated in release_log.rst, which readers
consult once at upgrade time and never search for how-to. Relocate it
to the task-oriented pages.
migrate.rst "Before you upgrade" gains:
- The pre-1.3.0 pickle constraint, called out as an ordering hazard.
A Constants blob written by 1.2.x must be re-pickled ON 1.3/1.4;
after upgrading, the code that could rewrite it is gone. Every other
migration step is fixable afterwards, which is why this one cannot
live in a changelog.
- A replacement table for the warned removals (decode() for bytes,
set(manager), discard(), Constants()/CONSTANTS.copy(), plain
attribute assignment, .get()). The section previously assumed a
clean -W error::DeprecationWarning run and offered nothing to the
readers who most need it -- those who didn't get one.
- A pointer to tools/differential/ for diffing 1.4 vs 2.0 over the
reader's own corpus, noting it is source-repo tooling, not installed.
migrate.rst also inlines the casefold example (STRASSE/Straße) and the
two behavior-diff shapes worth grepping fixtures for, both of which
previously redirected to the release log.
locales.rst gains "What works without a pack". The page listed two
packs, so a reader with Arabic or Hebrew data concluded there was no
support -- while the five-script default vocabulary from #269 handles
it out of the box and was documented nowhere but the changelog. Also
records which entries are deliberately held back and how to add them.
Writing that last example surfaced the reason to document it: adding an
honorific to given_name_titles ALONE silently does nothing, because the
field is a marker over titles rather than its own vocabulary. The
doctest caught it; the text now says so.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>1 parent 9be1df7 commit 3edfe4e
2 files changed
Lines changed: 115 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 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 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
10 | 58 | | |
11 | 59 | | |
12 | 60 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
46 | 46 | | |
47 | 47 | | |
48 | 48 | | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
49 | 89 | | |
50 | 90 | | |
51 | 91 | | |
| |||
263 | 303 | | |
264 | 304 | | |
265 | 305 | | |
266 | | - | |
267 | | - | |
| 306 | + | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
| 312 | + | |
268 | 313 | | |
269 | 314 | | |
270 | 315 | | |
271 | 316 | | |
272 | 317 | | |
273 | | - | |
274 | | - | |
275 | | - | |
276 | | - | |
277 | | - | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
| 328 | + | |
| 329 | + | |
| 330 | + | |
| 331 | + | |
| 332 | + | |
| 333 | + | |
| 334 | + | |
| 335 | + | |
| 336 | + | |
| 337 | + | |
0 commit comments