Google Git
Sign in
chromium / external / github.com / python / cpython / refs/tags/2.0 / . / Doc / TODO
blob: df6f7952ff539995453c4882ee17d21f2e6287ef [file] [log] [blame]
Fred Drakeb8660201998-02-18 16:03:43[diff] [blame]1PYTHON DOCUMENTATION TO-DO LIST -*- indented-text -*-
Fred Drake81f4b661998-02-17 19:01:02[diff] [blame]2===============================
3
Fred Drakee39dab62000-07-31 18:18:27[diff] [blame]4General
5-------
6
7* Figure out HTMLHelp generation for the Windows world.
8
9* Straighten out random/whrandom. Things are generally in the right
10 place, but need to respond to comments in email from Jan Kim
11 <kim@mpiz-koeln.mpg.de>.
12
13
14Python/C API
15------------
Fred Drake81f4b661998-02-17 19:01:02[diff] [blame]16
Fred Drake5a8aaa71999-07-02 14:31:41[diff] [blame]17* The "Very High Level Interface" in the API document has been
18 requested; I guess it wouldn't hurt to fill in a bit there. Request
19 by Albert Hofkamp <a.hofkamp@wtb.tue.nl>. (Partly done.)
20
Fred Drake8ece8041999-02-22 14:37:18[diff] [blame]21* Describe implementing types in C, including use of the 'self'
22 parameter to the method implementation function. (Missing material
23 mentioned in the Extending & Embedding manual, section 1.1; problem
Fred Drakee39dab62000-07-31 18:18:27[diff] [blame]24 reported by Clay Spence <cspence@sarnoff.com>.) Heavily impacts one
25 chapter of the Python/C API manual.
Fred Drake8ece8041999-02-22 14:37:18[diff] [blame]26
Fred Drakee39dab62000-07-31 18:18:27[diff] [blame]27* Missing PyArg_ParseTuple(), PyArg_ParseTupleAndKeywords(),
28 Py_BuildValue(). Information requested by Greg Kochanski
29 <gpk@bell-labs.com>. PyEval_EvalCode() has also been requested.
Fred Drake10682c21999-04-23 15:15:58[diff] [blame]30
Fred Drakee39dab62000-07-31 18:18:27[diff] [blame]31Extending & Embedding
32---------------------
33
34* More information is needed about building dynamically linked
35 extensions in C++. Specifically, the extensions must be linked
36 against the C++ libraries (and possibly runtime). Also noted by
37 Albert Hofkamp <a.hofkamp@wtb.tue.nl>.
38
39Reference Manual
40----------------
41
42* Document the Extended Call Syntax in the language reference.
43 [Jeremy Hylton]
44
45* Document new comparison support for recursive objects (lang. ref.?
46 library ref.? (cmp() function). [Jeremy Hylton]
47
Fred Drake8377f5d2000-08-24 00:50:27[diff] [blame]48* Augmented assignment. [Thomas Wouters]
49
Fred Drakee39dab62000-07-31 18:18:27[diff] [blame]50Library Reference
51-----------------
52
53* urllib2 module reference. [Jeremy Hylton]
Fred Drake90938341999-12-23 17:22:13[diff] [blame]54
Fred Drake8d43a291999-01-12 21:31:16[diff] [blame]55* Update the pickle documentation to describe all of the current
Fred Drake6a90b5e1999-12-21 23:02:38[diff] [blame]56 behavior; only a subset is described. __reduce__, etc. Partial
57 update submitted by Jim Kerr <jbkerr@sr.hp.com>.
Fred Drake81f4b661998-02-17 19:01:02[diff] [blame]58
Fred Drake0f353ed2000-06-29 03:33:28[diff] [blame]59* Update the httplib documentation to match Greg Stein's HTTP/1.1
60 support and new classes. (Greg, this is yours!)
61
Fred Drake33642ac2000-08-31 05:08:00[diff] [blame]62* SSL support in the socket module is not documented.
63
Fred Drakee39dab62000-07-31 18:18:27[diff] [blame]64Tutorial
65--------
66
67* Update tutorial to use string methods and talk about backward
68 compatibility of same.
69
Fred Drake6a90b5e1999-12-21 23:02:38[diff] [blame]70
71NOT WORTH THE TROUBLE
72---------------------
73
Fred Drake8d43a291999-01-12 21:31:16[diff] [blame]74* In the indexes, some subitem entries are separated from the item
75 entries by column- or page-breaks. Reported by Lorenzo M. Catucci
Fred Drake9ef86351999-04-29 04:23:37[diff] [blame]76 <lorenzo@argon.roma2.infn.it>. This one will be hard; probably not
Fred Drake5a8aaa71999-07-02 14:31:41[diff] [blame]77 really worth the pain. (Only an issue at all when a header-letter
78 and the first index entry get separated -- can change as soon as we
Fred Drakee39dab62000-07-31 18:18:27[diff] [blame]79 change the index entries in the text.) Also only a problem in the
80 print version.
Fred Drake13529c41998-07-24 13:02:17[diff] [blame]81
82* Fix problem with howto documents getting the last module synopsis
83 twice (in \localmoduletable) so we can get rid of the ugly 'uniq'
Fred Drake6a90b5e1999-12-21 23:02:38[diff] [blame]84 hack in tools/mkhowto. (Probably not worth the trouble of fixing.)