Doc/TODO

   1 PYTHON DOCUMENTATION TO-DO LIST                 -*- indented-text -*-
   2 ===============================
   3
   4
   5 * 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
   9 * 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
  14 * 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
  19 * Update the pickle documentation to describe all of the current
  20   behavior; only a subset is described.  __reduce__, etc.
  21
  22 * Update the code/codeop module documentation.
  23
  24 * In the indexes, some subitem entries are separated from the item
  25   entries by column- or page-breaks.  Reported by Lorenzo M. Catucci
  26   <lorenzo@argon.roma2.infn.it>.  This one will be hard; probably not
  27   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.)
  30
  31 * Fix problem with howto documents getting the last module synopsis
  32   twice (in \localmoduletable) so we can get rid of the ugly 'uniq'
  33   hack in tools/mkhowto.sh.  (Probably not worth the trouble of
  34   fixing.)
  35
  36 * Figure out HTMLHelp generation for the Windows world.
  37
  38 * Straighten out random/whrandom.
  39
  40
  41 BEFORE 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".