|
| 1 | + -*- text -*- |
| 2 | + |
| 3 | +If you edited Misc/NEWS before it was converted to ReST format skimming this |
| 4 | +file should help make the transition a bit easier. For full details about |
| 5 | +Docutils and ReST, go to the Docutils website: |
| 6 | + |
| 7 | + http://docutils.sourceforge.net/ |
| 8 | + |
| 9 | +To process Misc/NEWS using Docutils, you'll need the latest docutils |
| 10 | +snapshot: |
| 11 | + |
| 12 | + http://docutils.sf.net/docutils-snapshot.tgz |
| 13 | + |
| 14 | +David Goodger made a change to the allowable structure of internal |
| 15 | +references which greatly simplified initial conversion of the file. |
| 16 | + |
| 17 | +The changes required fell into the following categories: |
| 18 | + |
| 19 | +* The top-level "What's New" section headers changed to: |
| 20 | + |
| 21 | + What's New in Python 2.3 alpha 1? |
| 22 | + ================================= |
| 23 | + |
| 24 | + *XXX Release date: DD-MMM-2002 XXX* |
| 25 | + |
| 26 | +* Subsections are underlined with a single row of hyphens: |
| 27 | + |
| 28 | + Type/class unification and new-style classes |
| 29 | + -------------------------------------------- |
| 30 | + |
| 31 | +* Places where "balanced" single quotes were used were changed to use |
| 32 | + apostrophes as both the opening and closing quote (`string' -> 'string'). |
| 33 | + |
| 34 | +* In a few places asterisks needed to be escaped which would otherwise have |
| 35 | + been interpreted as beginning blocks of italic or bold text, e.g.: |
| 36 | + |
| 37 | + - The type of tp_free has been changed from "void (*)(PyObject \*)" |
| 38 | + to "void (*)(void \*)". |
| 39 | + |
| 40 | + Note that only the asterisks preceded by whitespace needed to be escaped. |
| 41 | + |
| 42 | +* One instance of a word ending with an underscore needed to be quoted |
| 43 | + ("PyCmp_" became "``PyCmp_``"). |
| 44 | + |
| 45 | +* One table was converted to ReST form (search Misc/NEWS for "New codecs" |
| 46 | + for this example). |
| 47 | + |
| 48 | +* A few places where chunks of code or indented text were displayed needed |
| 49 | + to be properly introduced (preceding paragraph terminated by "::" and the |
| 50 | + chunk of code or text indented w.r.t. the paragraph). For example: |
| 51 | + |
| 52 | + - Note that PyLong_AsDouble can fail! This has always been true, |
| 53 | + but no callers checked for it. It's more likely to fail now, |
| 54 | + because overflow errors are properly detected now. The proper way |
| 55 | + to check: :: |
| 56 | + |
| 57 | + double x = PyLong_AsDouble(some_long_object); |
| 58 | + if (x == -1.0 && PyErr_Occurred()) { |
| 59 | + /* The conversion failed. */ |
| 60 | + } |
0 commit comments