Doc/TODO

   1 PYTHON DOCUMENTATION TO-DO LIST                 -*- indented-text -*-
   2 ===============================
   3
   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 ------------
  16
  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
  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
  24   reported by Clay Spence <cspence@sarnoff.com>.)  Heavily impacts one
  25   chapter of the Python/C API manual.
  26
  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.
  30
  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
  48 * Augmented assignment.  [Thomas Wouters]
  49
  50 Library Reference
  51 -----------------
  52
  53 * urllib2 module reference.  [Jeremy Hylton]
  54
  55 * Update the pickle documentation to describe all of the current
  56   behavior; only a subset is described.  __reduce__, etc.  Partial
  57   update submitted by Jim Kerr <jbkerr@sr.hp.com>.
  58
  59 * Update the httplib documentation to match Greg Stein's HTTP/1.1
  60   support and new classes.  (Greg, this is yours!)
  61
  62 * SSL support in the socket module is not documented.
  63
  64 Tutorial
  65 --------
  66
  67 * Update tutorial to use string methods and talk about backward
  68   compatibility of same.
  69
  70
  71 NOT WORTH THE TROUBLE
  72 ---------------------
  73
  74 * In the indexes, some subitem entries are separated from the item
  75   entries by column- or page-breaks.  Reported by Lorenzo M. Catucci
  76   <lorenzo@argon.roma2.infn.it>.  This one will be hard; probably not
  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
  79   change the index entries in the text.)  Also only a problem in the
  80   print version.
  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'
  84   hack in tools/mkhowto.  (Probably not worth the trouble of fixing.)