| Fred Drake | b866020 | 1998-02-18 16:03:43 +0000 | [diff] [blame] | 1 | PYTHON DOCUMENTATION TO-DO LIST -*- indented-text -*- |
| Fred Drake | 81f4b66 | 1998-02-17 19:01:02 +0000 | [diff] [blame] | 2 | =============================== |
| 3 | |
| Fred Drake | e39dab6 | 2000-07-31 18:18:27 +0000 | [diff] [blame] | 4 | General |
| 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 | |
| 14 | Python/C API |
| 15 | ------------ |
| Fred Drake | 81f4b66 | 1998-02-17 19:01:02 +0000 | [diff] [blame] | 16 | |
| Fred Drake | 5a8aaa7 | 1999-07-02 14:31:41 +0000 | [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 Drake | 8ece804 | 1999-02-22 14:37:18 +0000 | [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 Drake | e39dab6 | 2000-07-31 18:18:27 +0000 | [diff] [blame] | 24 | reported by Clay Spence <cspence@sarnoff.com>.) Heavily impacts one |
| 25 | chapter of the Python/C API manual. |
| Fred Drake | 8ece804 | 1999-02-22 14:37:18 +0000 | [diff] [blame] | 26 | |
| Fred Drake | e39dab6 | 2000-07-31 18:18:27 +0000 | [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 Drake | 10682c2 | 1999-04-23 15:15:58 +0000 | [diff] [blame] | 30 | |
| Fred Drake | e39dab6 | 2000-07-31 18:18:27 +0000 | [diff] [blame] | 31 | Extending & 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 | |
| 39 | Reference 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 Drake | 8377f5d | 2000-08-24 00:50:27 +0000 | [diff] [blame] | 48 | * Range literals need to be documented. [Thomas Wouters] |
| 49 | |
| 50 | * Augmented assignment. [Thomas Wouters] |
| 51 | |
| Fred Drake | e39dab6 | 2000-07-31 18:18:27 +0000 | [diff] [blame] | 52 | Library Reference |
| 53 | ----------------- |
| 54 | |
| 55 | * urllib2 module reference. [Jeremy Hylton] |
| Fred Drake | 9093834 | 1999-12-23 17:22:13 +0000 | [diff] [blame] | 56 | |
| Fred Drake | 8d43a29 | 1999-01-12 21:31:16 +0000 | [diff] [blame] | 57 | * Update the pickle documentation to describe all of the current |
| Fred Drake | 6a90b5e | 1999-12-21 23:02:38 +0000 | [diff] [blame] | 58 | behavior; only a subset is described. __reduce__, etc. Partial |
| 59 | update submitted by Jim Kerr <jbkerr@sr.hp.com>. |
| Fred Drake | 81f4b66 | 1998-02-17 19:01:02 +0000 | [diff] [blame] | 60 | |
| Fred Drake | 0f353ed | 2000-06-29 03:33:28 +0000 | [diff] [blame] | 61 | * Update the httplib documentation to match Greg Stein's HTTP/1.1 |
| 62 | support and new classes. (Greg, this is yours!) |
| 63 | |
| Fred Drake | 33642ac | 2000-08-31 05:08:00 +0000 | [diff] [blame] | 64 | * SSL support in the socket module is not documented. |
| 65 | |
| Fred Drake | e39dab6 | 2000-07-31 18:18:27 +0000 | [diff] [blame] | 66 | Tutorial |
| 67 | -------- |
| 68 | |
| 69 | * Update tutorial to use string methods and talk about backward |
| 70 | compatibility of same. |
| 71 | |
| Fred Drake | 6a90b5e | 1999-12-21 23:02:38 +0000 | [diff] [blame] | 72 | |
| 73 | NOT WORTH THE TROUBLE |
| 74 | --------------------- |
| 75 | |
| Fred Drake | 8d43a29 | 1999-01-12 21:31:16 +0000 | [diff] [blame] | 76 | * In the indexes, some subitem entries are separated from the item |
| 77 | entries by column- or page-breaks. Reported by Lorenzo M. Catucci |
| Fred Drake | 9ef8635 | 1999-04-29 04:23:37 +0000 | [diff] [blame] | 78 | <lorenzo@argon.roma2.infn.it>. This one will be hard; probably not |
| Fred Drake | 5a8aaa7 | 1999-07-02 14:31:41 +0000 | [diff] [blame] | 79 | really worth the pain. (Only an issue at all when a header-letter |
| 80 | and the first index entry get separated -- can change as soon as we |
| Fred Drake | e39dab6 | 2000-07-31 18:18:27 +0000 | [diff] [blame] | 81 | change the index entries in the text.) Also only a problem in the |
| 82 | print version. |
| Fred Drake | 13529c4 | 1998-07-24 13:02:17 +0000 | [diff] [blame] | 83 | |
| 84 | * Fix problem with howto documents getting the last module synopsis |
| 85 | twice (in \localmoduletable) so we can get rid of the ugly 'uniq' |
| Fred Drake | 6a90b5e | 1999-12-21 23:02:38 +0000 | [diff] [blame] | 86 | hack in tools/mkhowto. (Probably not worth the trouble of fixing.) |