blob: 8a467fe0a89eef33e1f6a95ae3b03daea3290ff5 [file] [log] [blame]
Fred Drakeb8660201998-02-18 16:03:43 +00001PYTHON DOCUMENTATION TO-DO LIST -*- indented-text -*-
Fred Drake81f4b661998-02-17 19:01:02 +00002===============================
3
Fred Drakee39dab62000-07-31 18:18:27 +00004General
5-------
6
7* Figure out HTMLHelp generation for the Windows world.
8
Fred Drakee39dab62000-07-31 18:18:27 +00009
10Python/C API
11------------
Fred Drake81f4b661998-02-17 19:01:02 +000012
Fred Drake5a8aaa71999-07-02 14:31:41 +000013* The "Very High Level Interface" in the API document has been
14 requested; I guess it wouldn't hurt to fill in a bit there. Request
15 by Albert Hofkamp <a.hofkamp@wtb.tue.nl>. (Partly done.)
16
Fred Drake8ece8041999-02-22 14:37:18 +000017* Describe implementing types in C, including use of the 'self'
18 parameter to the method implementation function. (Missing material
19 mentioned in the Extending & Embedding manual, section 1.1; problem
Fred Drakee39dab62000-07-31 18:18:27 +000020 reported by Clay Spence <cspence@sarnoff.com>.) Heavily impacts one
21 chapter of the Python/C API manual.
Fred Drake8ece8041999-02-22 14:37:18 +000022
Fred Drakee39dab62000-07-31 18:18:27 +000023* Missing PyArg_ParseTuple(), PyArg_ParseTupleAndKeywords(),
24 Py_BuildValue(). Information requested by Greg Kochanski
25 <gpk@bell-labs.com>. PyEval_EvalCode() has also been requested.
Fred Drake10682c21999-04-23 15:15:58 +000026
Fred Drakee39dab62000-07-31 18:18:27 +000027Extending & Embedding
28---------------------
29
30* More information is needed about building dynamically linked
31 extensions in C++. Specifically, the extensions must be linked
32 against the C++ libraries (and possibly runtime). Also noted by
33 Albert Hofkamp <a.hofkamp@wtb.tue.nl>.
34
35Reference Manual
36----------------
37
38* Document the Extended Call Syntax in the language reference.
39 [Jeremy Hylton]
40
41* Document new comparison support for recursive objects (lang. ref.?
42 library ref.? (cmp() function). [Jeremy Hylton]
43
44Library Reference
45-----------------
46
Fred Drake8d43a291999-01-12 21:31:16 +000047* Update the pickle documentation to describe all of the current
Fred Drake6a90b5e1999-12-21 23:02:38 +000048 behavior; only a subset is described. __reduce__, etc. Partial
49 update submitted by Jim Kerr <jbkerr@sr.hp.com>.
Fred Drake81f4b661998-02-17 19:01:02 +000050
Fred Drake0f353ed2000-06-29 03:33:28 +000051* Update the httplib documentation to match Greg Stein's HTTP/1.1
52 support and new classes. (Greg, this is yours!)
53
Fred Drakee39dab62000-07-31 18:18:27 +000054Tutorial
55--------
56
57* Update tutorial to use string methods and talk about backward
58 compatibility of same.
59
Fred Drake6a90b5e1999-12-21 23:02:38 +000060
61NOT WORTH THE TROUBLE
62---------------------
63
Fred Drake8d43a291999-01-12 21:31:16 +000064* In the indexes, some subitem entries are separated from the item
65 entries by column- or page-breaks. Reported by Lorenzo M. Catucci
Fred Drake9ef86351999-04-29 04:23:37 +000066 <lorenzo@argon.roma2.infn.it>. This one will be hard; probably not
Fred Drake5a8aaa71999-07-02 14:31:41 +000067 really worth the pain. (Only an issue at all when a header-letter
68 and the first index entry get separated -- can change as soon as we
Fred Drakee39dab62000-07-31 18:18:27 +000069 change the index entries in the text.) Also only a problem in the
70 print version.
Fred Drake13529c41998-07-24 13:02:17 +000071
72* Fix problem with howto documents getting the last module synopsis
73 twice (in \localmoduletable) so we can get rid of the ugly 'uniq'
Fred Drake6a90b5e1999-12-21 23:02:38 +000074 hack in tools/mkhowto. (Probably not worth the trouble of fixing.)