sys/src/cmd/python/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
  10 Python/C API
  11 ------------
  12
  13 * 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
  17 * 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
  20   reported by Clay Spence <cspence@sarnoff.com>.)  Heavily impacts one
  21   chapter of the Python/C API manual.
  22
  23 * Missing PyArg_ParseTuple(), PyArg_ParseTupleAndKeywords(),
  24   Py_BuildValue().  Information requested by Greg Kochanski
  25   <gpk@bell-labs.com>.  PyEval_EvalCode() has also been requested.
  26
  27 Extending & 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
  35 Reference 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
  44 Library Reference
  45 -----------------
  46
  47 * Update the pickle documentation to describe all of the current
  48   behavior; only a subset is described.  __reduce__, etc.  Partial
  49   update submitted by Jim Kerr <jbkerr@sr.hp.com>.
  50
  51 * Update the httplib documentation to match Greg Stein's HTTP/1.1
  52   support and new classes.  (Greg, this is yours!)
  53
  54 Tutorial
  55 --------
  56
  57 * Update tutorial to use string methods and talk about backward
  58   compatibility of same.
  59
  60
  61 NOT WORTH THE TROUBLE
  62 ---------------------
  63
  64 * In the indexes, some subitem entries are separated from the item
  65   entries by column- or page-breaks.  Reported by Lorenzo M. Catucci
  66   <lorenzo@argon.roma2.infn.it>.  This one will be hard; probably not
  67   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
  69   change the index entries in the text.)  Also only a problem in the
  70   print version.
  71
  72 * Fix problem with howto documents getting the last module synopsis
  73   twice (in \localmoduletable) so we can get rid of the ugly 'uniq'
  74   hack in tools/mkhowto.  (Probably not worth the trouble of fixing.)