Mercurial > cpython-lru_cache-weakref

annotate Misc/NEWS.help @ 54294:dba767bc3155 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
remove mention of old ctypes version
author Benjamin Peterson <benjamin@python.org>
date Sat, 23 May 2009 20:59:09 +0000
parents 00e619851a56
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25334
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
1 -*- text -*-
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
2
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
3 If you edited Misc/NEWS before it was converted to ReST format skimming this
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
4 file should help make the transition a bit easier. For full details about
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
5 Docutils and ReST, go to the Docutils website:
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
6
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
7 http://docutils.sourceforge.net/
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
8
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
9 To process Misc/NEWS using Docutils, you'll need the latest docutils
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
10 snapshot:
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
11
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
12 http://docutils.sf.net/docutils-snapshot.tgz
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
13
33338
00e619851a56 Bug #1014775: update NEWS.help for changes in docutils.
Johannes Gijsbers <jlg@dds.nl>
parents: 27042
diff changeset
14 Docutils works with Python 2.2 or newer.
26973
90998079a1a2 Add recipe for creating NEWS.html.
Guido van Rossum <guido@python.org>
parents: 25492
diff changeset
15
27042
188416fb7ac5 Updated (2.3 OK now)
David Goodger <goodger@python.org>
parents: 26973
diff changeset
16 To process NEWS into NEWS.html, first install Docutils, and then run
188416fb7ac5 Updated (2.3 OK now)
David Goodger <goodger@python.org>
parents: 26973
diff changeset
17 this command:
26973
90998079a1a2 Add recipe for creating NEWS.html.
Guido van Rossum <guido@python.org>
parents: 25492
diff changeset
18
33338
00e619851a56 Bug #1014775: update NEWS.help for changes in docutils.
Johannes Gijsbers <jlg@dds.nl>
parents: 27042
diff changeset
19 python .../docutils/tools/rst2html.py NEWS NEWS.html
26973
90998079a1a2 Add recipe for creating NEWS.html.
Guido van Rossum <guido@python.org>
parents: 25492
diff changeset
20
90998079a1a2 Add recipe for creating NEWS.html.
Guido van Rossum <guido@python.org>
parents: 25492
diff changeset
21 Here ".../docutils" is the directory into which the above snapshot was
90998079a1a2 Add recipe for creating NEWS.html.
Guido van Rossum <guido@python.org>
parents: 25492
diff changeset
22 extracted. (I hope this recipe will change for the better.)
90998079a1a2 Add recipe for creating NEWS.html.
Guido van Rossum <guido@python.org>
parents: 25492
diff changeset
23
25334
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
24 David Goodger made a change to the allowable structure of internal
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
25 references which greatly simplified initial conversion of the file.
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
26
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
27 The changes required fell into the following categories:
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
28
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
29 * The top-level "What's New" section headers changed to:
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
30
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
31 What's New in Python 2.3 alpha 1?
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
32 =================================
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
33
27042
188416fb7ac5 Updated (2.3 OK now)
David Goodger <goodger@python.org>
parents: 26973
diff changeset
34 *Release date: DD-MMM-2002*
188416fb7ac5 Updated (2.3 OK now)
David Goodger <goodger@python.org>
parents: 26973
diff changeset
35
188416fb7ac5 Updated (2.3 OK now)
David Goodger <goodger@python.org>
parents: 26973
diff changeset
36 Note that the release date line is emphasized, with a "*" at each
188416fb7ac5 Updated (2.3 OK now)
David Goodger <goodger@python.org>
parents: 26973
diff changeset
37 end.
25334
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
38
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
39 * Subsections are underlined with a single row of hyphens:
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
40
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
41 Type/class unification and new-style classes
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
42 --------------------------------------------
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
43
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
44 * Places where "balanced" single quotes were used were changed to use
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
45 apostrophes as both the opening and closing quote (`string' -> 'string').
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
46
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
47 * In a few places asterisks needed to be escaped which would otherwise have
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
48 been interpreted as beginning blocks of italic or bold text, e.g.:
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
49
25492
2ac7b0964c7b fix a couple nits related to my understanding of ReST. Use of
Skip Montanaro <skip@pobox.com>
parents: 25334
diff changeset
50 - The type of tp_free has been changed from "``void (*)(PyObject *)``"
2ac7b0964c7b fix a couple nits related to my understanding of ReST. Use of
Skip Montanaro <skip@pobox.com>
parents: 25334
diff changeset
51 to "``void (*)(void *)``".
25334
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
52
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
53 Note that only the asterisks preceded by whitespace needed to be escaped.
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
54
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
55 * One instance of a word ending with an underscore needed to be quoted
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
56 ("PyCmp_" became "``PyCmp_``").
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
57
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
58 * One table was converted to ReST form (search Misc/NEWS for "New codecs"
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
59 for this example).
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
60
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
61 * A few places where chunks of code or indented text were displayed needed
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
62 to be properly introduced (preceding paragraph terminated by "::" and the
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
63 chunk of code or text indented w.r.t. the paragraph). For example:
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
64
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
65 - Note that PyLong_AsDouble can fail! This has always been true,
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
66 but no callers checked for it. It's more likely to fail now,
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
67 because overflow errors are properly detected now. The proper way
25492
2ac7b0964c7b fix a couple nits related to my understanding of ReST. Use of
Skip Montanaro <skip@pobox.com>
parents: 25334
diff changeset
68 to check::
25334
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
69
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
70 double x = PyLong_AsDouble(some_long_object);
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
71 if (x == -1.0 && PyErr_Occurred()) {
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
72 /* The conversion failed. */
9f61710628c4 brief help file for people editing Misc/NEWS
Skip Montanaro <skip@pobox.com>
parents:
diff changeset
73 }