blob: aa4b8d2acbc740e235e0eca1993012e7490ff0ae [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
4
Fred Drake5a8aaa71999-07-02 14:31:41 +00005* The "Very High Level Interface" in the API document has been
6 requested; I guess it wouldn't hurt to fill in a bit there. Request
7 by Albert Hofkamp <a.hofkamp@wtb.tue.nl>. (Partly done.)
8
Fred Drake8ece8041999-02-22 14:37:18 +00009* Describe implementing types in C, including use of the 'self'
10 parameter to the method implementation function. (Missing material
11 mentioned in the Extending & Embedding manual, section 1.1; problem
12 reported by Clay Spence <cspence@sarnoff.com>.)
13
Fred Drake10682c21999-04-23 15:15:58 +000014* In the extensions manual, more information is needed about building
15 dynamically linked extensions in C++. Specifically, the extensions
16 must be linked against the C++ libraries (and possibly runtime).
17 Also noted by Albert Hofkamp <a.hofkamp@wtb.tue.nl>.
18
Fred Drake8d43a291999-01-12 21:31:16 +000019* Update the pickle documentation to describe all of the current
20 behavior; only a subset is described. __reduce__, etc.
Fred Drake81f4b661998-02-17 19:01:02 +000021
Fred Drake5a8aaa71999-07-02 14:31:41 +000022* Update the code/codeop module documentation.
Fred Drakee0208cc1999-04-22 13:05:52 +000023
Fred Drake8d43a291999-01-12 21:31:16 +000024* In the indexes, some subitem entries are separated from the item
25 entries by column- or page-breaks. Reported by Lorenzo M. Catucci
Fred Drake9ef86351999-04-29 04:23:37 +000026 <lorenzo@argon.roma2.infn.it>. This one will be hard; probably not
Fred Drake5a8aaa71999-07-02 14:31:41 +000027 really worth the pain. (Only an issue at all when a header-letter
28 and the first index entry get separated -- can change as soon as we
29 change the index entries in the text.)
Fred Drake13529c41998-07-24 13:02:17 +000030
31* Fix problem with howto documents getting the last module synopsis
32 twice (in \localmoduletable) so we can get rid of the ugly 'uniq'
Fred Drake9ef86351999-04-29 04:23:37 +000033 hack in tools/mkhowto.sh. (Probably not worth the trouble of
34 fixing.)
Fred Drake8d43a291999-01-12 21:31:16 +000035
Fred Drake8d43a291999-01-12 21:31:16 +000036* Figure out HTMLHelp generation for the Windows world.
Fred Drake873f0291999-06-17 15:20:44 +000037
Fred Drake9ed56de1999-08-19 15:37:35 +000038* Straighten out random/whrandom.
39
Fred Drake9b59a301999-06-29 18:54:03 +000040
41BEFORE NEXT PYTHON RELEASE, BUT NOT UNTIL THEN:
42
43* Document that the mode parameter to wave.open() may be omitted, and
44 how it is determined if omitted. (Same of aifc, sunau open()
45 functions.)
46
47* Document that fpformat.NotANumber is a subclass of ValueError, has
48 the string that failed as the "exception value".