Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
14,273 Commits 6 Branches 592 Tags 2.4 GiB
Commit Graph

3082 Commits

Author SHA1 Message Date
Greg Ward 822a86a955 Trying to placate Fred: redefine \tilde and \bslash; document everything. 
Still some not-quite-standard definitions in here that I have to fix.
 2000-04-12 01:44:35 +00:00
Greg Ward d5faa7ea08 Changed the table of per-platform default installation locations to be 
more consistent with the rest of the Python docs.
 2000-04-12 01:42:19 +00:00
Fred Drake ee775a194c Make use of \longprogramopt where appropriate. 2000-04-11 19:46:40 +00:00
Fred Drake 2b85341776 Elaborate descriptions of \e, \module. 
Describe policy on vertical lines in tables.
 2000-04-11 19:08:30 +00:00
Fred Drake ce44498ba8 Revise the description of \programopt, document \longprogramopt. 2000-04-11 18:52:52 +00:00
Fred Drake 493624941a \longprogramopt: New macro. 2000-04-11 18:47:59 +00:00
Fred Drake 0cd6021339 do_cmd_longprogramopt(): New function. 2000-04-11 18:46:59 +00:00
Greg Ward 08c68fc82d LaTeX macros for the Distutils manuals. 
Perhaps these should be added to the standard Python style file?
 2000-04-11 02:01:52 +00:00
Greg Ward c392caa390 Spewed a bunch more verbiage. 
Lots of scattered wording changes.
 2000-04-11 02:00:26 +00:00
Fred Drake 8520cc2328 Added reference count information for Py_FindMethod(). 2000-04-10 19:38:24 +00:00
Fred Drake 7357770153 Yet another markup nit: functions that are part of the Python/C API 
are still C functions, and should be marked.
 2000-04-10 18:50:14 +00:00
Fred Drake 37f41565a8 PyErr_Format(): 
Remove statement that the return value is always NULL; this is
        generated by the formatting.
 2000-04-10 18:46:22 +00:00
Jeremy Hylton 98605b54b4 document PyErr_Format 2000-04-10 18:40:57 +00:00
Fred Drake 0682be4524 letters: 
Fix description; lowercase and uppercase are strings, not
        functions!  Noted by Randall Hopper <aa8vb@yahoo.com>.

maketrans():
        Minor markup nits in description.
 2000-04-10 18:35:49 +00:00
Fred Drake 8394595f3b Add to the comment a description of the "null" value for returned 
PyObject* values.
 2000-04-10 18:29:21 +00:00
Fred Drake c2578c5bb6 load_refcounts(), 
do_env_cfuncdesc():  Support the "null" value for the refcounts field
        in refcounts.dat.
 2000-04-10 18:26:45 +00:00
Fred Drake db2764d941 The reference count field for PyErr_NoMemory() and 
PyErr_SetFromErrno() should be "null".
 2000-04-10 18:25:09 +00:00
Fred Drake 5e872de6c7 If the refcount field is "null", that's ok; the value will be None. 2000-04-10 18:24:26 +00:00
Fred Drake 729eca1b9d For functions which return a PyObject* but use "null" for the 
reference count field, state that the return value is always NULL.

(Useful for some PyErr_*() flavors.)
 2000-04-10 18:23:47 +00:00
Fred Drake 0a863da1f8 cfuncdesc environment: 
When processing the optional parameter, don't append any text;
        let the pre-processor supply all of it.
 2000-04-10 18:21:38 +00:00
Fred Drake adb272ceee do_cmd_datalineni(): New function, to implement the non-indexing form 
of \dataline.
 2000-04-10 17:47:14 +00:00
Greg Ward c248baecb3 Moved definition of \XXX command out to distutils.sty. 2000-04-09 20:55:35 +00:00
Greg Ward 6002ffc38c Wrote the introduction (including several subsections). 
Started writing the "Standard Build and Install" section.
 2000-04-09 20:54:50 +00:00
Greg Ward facb8dbaeb Fixed so LaTeX can actually process it, and so it looks like the other 
Distutils manual.
 2000-04-09 04:32:40 +00:00
Greg Ward 16aafcd85b Got started for real on this manual. Completely untested and unread -- just 
checking it in so I can move things around in the CVS repository.
 2000-04-09 04:06:44 +00:00
Greg Ward 7593eb3267 Extracted a bunch of Distutils-specific commands and macros to distutils.sty 
(also needed by inst.tex).
 2000-04-09 03:59:15 +00:00
Fred Drake 9164f88657 Fix Skip's email address in his attribution! (Thanks, Skip!) 2000-04-08 04:53:29 +00:00
Fred Drake e7a8c972d8 Added support for the "Long HTML" version to the build/packaging 
process.
 2000-04-07 16:27:15 +00:00
Fred Drake c2c46c3751 New example from Skip Montanaro <skip@mojam.com>. 2000-04-07 16:09:59 +00:00
Fred Drake 46f14580cb Describe the purpose of the "long HTML" package. 2000-04-07 14:47:27 +00:00
Fred Drake cff5482d37 Mark RELEASE with the release level ("a2"). 2000-04-06 18:38:30 +00:00
Fred Drake 69ca950d1f Make sure the \declaremodule uses the right name for the module! 
Clean up several markup problems & inconsistencies.
 2000-04-06 16:09:59 +00:00
Fred Drake 343301aaa4 unichr(), 
unicode():  Added \versionadded{} annotations.
 2000-04-06 15:06:03 +00:00
Fred Drake 0b72116812 Marc-Andre Lemburg <mal@lemburg.com>: 
Added UnicodeType.
 2000-04-06 15:05:04 +00:00
Fred Drake 56ced2a7e4 Marc-Andre Lemburg <mal@lemburg.com>: 
Added note that Unicode strings are picklable.
 2000-04-06 15:04:30 +00:00
Fred Drake 5828ad6963 Revised / removed comments about string exceptions (relating to the 
standard exceptions), added documentation of UnboundLocalError.
 2000-04-06 15:03:01 +00:00
Fred Drake 3cb793e8e8 Marc-Andre Lemburg <mal@lemburg.com>: 
Added UnicodeError description.
 2000-04-06 14:48:35 +00:00
Fred Drake 61098f201e Marc-Andre Lemburg <mal@lemburg.com>: 
Add Unicode strings to the list of marshalable types.
 2000-04-06 14:47:20 +00:00
Fred Drake 665dd704a3 Note the exception raised when parameter to chr() is out of range. 2000-04-06 14:45:19 +00:00
Fred Drake 33d51841a3 Marc-Andre Lemburg <mal@lemburg.com>: 
Documentation for unichr(), unicode(), update for ord().
 2000-04-06 14:43:12 +00:00
Fred Drake 2097ef126b Added entry for codecs module. 2000-04-06 14:26:43 +00:00
Fred Drake 98f8a3d8da Added codecs entry here as part of String Services. 2000-04-06 14:25:28 +00:00
Fred Drake b7979c756c Marc-Andre Lemburg <mal@lemburg.com>: 
codecs module documentation, with some preliminary markup
adjustments from FLD.
 2000-04-06 14:21:58 +00:00
Fred Drake 9dc30bb956 Marc-Andre Lemburg <mal@lemburg.com>: 
Tutorial information about Unicode strings in Python, with some markup
adjustments from FLD.
 2000-04-06 14:17:03 +00:00
Fred Drake a4cd2611f4 Marc-Andre Lemburg <mal@lemburg.com>: 
API documentation for Unicode support from C.
 2000-04-06 14:10:29 +00:00
Fred Drake 8b3ce9e099 But don't do the funny \UNICODE macro; we're trying to get away from 
those markups!  <with-mixed-feelings>
 2000-04-06 14:00:14 +00:00
Fred Drake f0aff8e759 Patch from Marc-Andre Lemburg <mal@lemburg.com>: 
Added Unicode type to the language reference.
 2000-04-06 13:57:21 +00:00
Fred Drake 6d5c6bdb25 Removed bogus connect() call in SMTP example; reported by Travis 
B. Hartwell <slt5v@cc.usu.edu>.

Removed second copy of the "See also" section!
 2000-04-05 22:12:06 +00:00
Fred Drake 71b04dab58 Added reference to the multifile module from the "See also" section 
in the mimetools documentation.
Suggested by Skip Montanaro <skip@mojam.com>.
 2000-04-05 22:05:15 +00:00
Fred Drake d1a56f4235 Noted by Guido: 
Fixed up descriptions of altzone and timezone not to refer to the
0th meridian, which doesn't exist.  Reference is now to UTC.
 2000-04-05 15:06:03 +00:00
Fred Drake 898915d7e2 Noted by Guido: 
Directionality of up/down were confused.
 2000-04-05 15:01:36 +00:00
Fred Drake 43b89b637f Noted by Guido: 
Note in the "Caveats" section should refer to the exit() function, not
exit_thread().
 2000-04-05 15:00:38 +00:00
Fred Drake bf4041a0a6 Merged in changes from 1.5.2p2 release. 2000-04-04 20:58:39 +00:00
Fred Drake 02ba62141e Merged in changes from 1.5.2p2 release as appropriate. 2000-04-04 20:58:25 +00:00
Fred Drake 12ed36525a Added "See also" section; from Peter Funk <pf@artcom-gmbh.de> 
(re-written).
 2000-04-04 20:43:50 +00:00
Fred Drake 005f494a7f Added "See also" section; from Peter Funk <pf@artcom-gmbh.de>. 2000-04-04 20:42:38 +00:00
Fred Drake 69fbf33680 Fixed typo in example code; spotted by Everett Lipman 
<lipman@sphere.niddk.nih.gov>.
 2000-04-04 19:53:06 +00:00
Fred Drake 7d68690d8d Added notes about the eventual disappearance of two-parameter bind(), 
connect(), and connect_ex().

I didn't make these deprecation notices since it was never a
documented feature.
 2000-04-04 17:48:30 +00:00
Fred Drake 38e5d27cae Merged changes from the 1.5.2p2 release. 
(Very rough.)
 2000-04-03 20:13:55 +00:00
Fred Drake 659ebfa79e Merge in changes from the 1.5.2p2 release. 
Hopefully I got all this right!
 2000-04-03 15:42:13 +00:00
Fred Drake eb725cd045 Merged changes from the 1.5.2p2 release. 2000-04-03 15:06:40 +00:00
Fred Drake 6a0d844e76 UserString section: 
Small cleanups noted by Detlef Lannert
<lannert@lannert.rz.uni-duesseldorf.de>.

Make the spelling of Unicode always uppercase.
 2000-04-03 15:02:35 +00:00
Fred Drake 42934689ea Note that "Unicode" is always capitalized. 2000-04-03 15:00:28 +00:00
Fred Drake 54fd8452a1 Merge in changes from the 1.5.2p2 release. 2000-04-03 04:54:28 +00:00
Fred Drake e15956b465 Merged changes from the 1.5.2p2 release. 2000-04-03 04:51:13 +00:00
Fred Drake 20082d92f2 Merge in changes from the 1.5.2p2 release. 2000-04-03 04:26:58 +00:00
Fred Drake ba82878a3b Merged changes from the 1.5.2p2 release. 2000-04-03 04:19:14 +00:00
Fred Drake a22b576d05 UserString class from Peter Funk <pf@artcom-gmbh.de>. 2000-04-03 03:51:50 +00:00
Fred Drake 9a257b4fd4 Added --numeric option, similar to mkhtml.sh. 2000-03-31 20:27:36 +00:00
Fred Drake 9c26f5dbed Added rule to copy in the icons/ directory. 2000-03-31 20:26:33 +00:00
Fred Drake 3bb719f744 List of subdirs that are generated during the build. 2000-03-31 20:26:00 +00:00
Fred Drake e018beea94 Build rules for the "long HTML" version. 2000-03-31 20:22:29 +00:00
Fred Drake ddc6c276b7 Improve explanation of reference counts for PyString_Concat(). 2000-03-31 18:22:38 +00:00
Fred Drake 38d062d022 Reflect the two new sections in the dependencies. 2000-03-31 18:10:17 +00:00
Fred Drake 3c9f936eee Two new sections. Preliminary. 2000-03-31 17:51:10 +00:00
Jeremy Hylton a12c7a7620 Add PyDict_Copy() function to C API for dicts. It returns a new 
dictionary that contains the same key/value pairs as p.
 2000-03-30 22:27:31 +00:00
Fred Drake bdcc96c9e3 Changes from 1.5.2p2, plus fix a couple of errors noted by Hernan 
Martinez Foffani <hfoffani@sofrecom.com.ar>.
 2000-03-29 22:41:52 +00:00
Greg Ward 8e14f05ae6 Fix small errors in description of Mac, Windows installation schemes. 
Added comment about "--help" (no value) not working.
 2000-03-22 01:00:23 +00:00
Greg Ward 295765630a Third attempt at documenting an installation scheme; this one feels like 
it could work--reasonably short and straightforward to document, but
flexible enough that it will be able to handle more than just modules
and extensions in the future.
 2000-03-18 15:11:50 +00:00
Fred Drake dee86c644e Script to annotate api.tex with reference count information. 2000-03-15 14:57:59 +00:00
Greg Ward 169f91b808 [from 2000-02-25] Second attempt at describing an installation scheme; this is 
the simplified scheme that Guido proposed.  Also already-obsolete,
and saved only for posterity.
 2000-03-10 01:57:51 +00:00
Greg Ward 7c1e5f65e3 [from 2000-02-23] Description of the baroque and already-obsolete 
installation scheme that Fred Drake and I cooked up.  Only saved for
posterity.
 2000-03-10 01:56:58 +00:00
Fred Drake 15861b2a41 Update portability information for the spawn*() functions and related 
constants.  Someone will need to fill in information on the spawn*()
functions that aren't listed.
 2000-02-29 05:19:38 +00:00
Greg Ward abc52169b7 The "Distributing Python Modules" manual; currently empty (I'll get to it 
Real Soon Now(TM).
 2000-02-26 00:52:48 +00:00
Fred Drake 0baf773c44 Added entry for libtabnanny.tex. 2000-02-23 15:44:58 +00:00
Fred Drake 3c227eef91 Added dependency on libtabnanny.tex. 2000-02-23 15:44:34 +00:00
Fred Drake 155348be33 Initial version from Peter Funk <pf@artcom-gmbh.de>, with minor 
consistency changes and a note that the API may change in the future.
 2000-02-23 15:44:08 +00:00
Fred Drake 89af0776cd This branch is for 1.6 & forward. 2000-02-22 18:20:03 +00:00
Fred Drake c29e41df44 Script to help locate markup that LaTeX2HTML has a problem with. 2000-02-21 17:20:16 +00:00
Fred Drake 1e862e8a37 Update the description of int() to include the radix parameter; 
omission noted on c.l.py by Aahz Maruch.

Swapped the order of the descriptions of int() and intern() so that
int() comes first (the functions are in alphabetic order).
 2000-02-17 17:45:52 +00:00
Guido van Rossum 8006d316bc Added docs for new crc32() function. By Jim Ahlstrom. 
(Fred, please check.)
 2000-02-16 21:13:37 +00:00
Barry Warsaw 41d84631ba Document the API changes to the nntplib module (exceptions become 
classes, NNTP.__init__() grows a new optional argument to set reader
mode on the server).
 2000-02-10 20:26:45 +00:00
Fred Drake 2bb43a20ce The dircmp module is now obsolete. 2000-02-03 15:27:26 +00:00
Fred Drake ecb84f8e75 Don't insert extra indentation before <title> elements. 2000-01-20 22:51:14 +00:00
Fred Drake 9093834acb Added item about specific missing entries in the C API manual. 1999-12-23 17:22:13 +00:00
Fred Drake 6a90b5e4d0 Removed a couple of items that got done(!). 
Moved a couple to a new "Not worth it" section (explanations were
already there).
 1999-12-21 23:02:38 +00:00
Fred Drake 76e6da38c0 Document GetoptError and label error an alias. 1999-12-21 22:50:05 +00:00
Fred Drake b9bdfc6a23 Document 1.5.2+ aspects of the NotANumber exception. (Note that this 
is in the development branch, not the maintenance branch!)
 1999-12-21 18:45:16 +00:00
Fred Drake 89ab163479 Document that the |mode| parameter to open() is optional and explain how 
the default value is determined.
 1999-12-21 18:31:30 +00:00
Fred Drake 88f6ca2ce9 Document getgroups(), getlogin(), fpathconf(), pathconf(), 
pathconf_names, confstr(), confstr_names, sysconf(), sysconf_names.
 1999-12-15 19:39:04 +00:00
Fred Drake d16b5abc07 Markup consistency nits that Guido didn't check. ;-) 1999-12-13 23:34:42 +00:00
Guido van Rossum 5f7a28cdf8 Doc update from Piers Lauder see changes for imaplib.py version 2.16. 1999-12-13 23:29:39 +00:00
Fred Drake 18f7a45324 Document the new stuff in the os module. 1999-12-09 22:11:43 +00:00
Fred Drake d4d4ba3fd2 Update link to PythonWare library page. 1999-12-01 18:44:09 +00:00
Fred Drake 645af9fedd rewrite_descriptor(): Fixup conversion of arguments (simpler). 
join_adjacent_elements():  Hack to merge adjacent instances of
        <option>; the source \programopt with GNU-style long options
        created problems with LaTeX2HTML; this removes the evil
        workaround, which should never be necessary from structured
        documents(!).
 1999-11-23 21:52:03 +00:00
Fred Drake 8a3b4495df Don't rename \var to <varname>; DocBook is too verbose here. 
Do adopt DocBook's <command>, <option>, <envar> names for \program,
\programopt, \envvar.

Add \filenq --> <filename quote="no"> (it has to go somewhere, at
least for now).
 1999-11-23 21:48:41 +00:00
Fred Drake d81b1b0ffa Set the date and version to reflect the actual status, not the last 
released status.  Has to be changed just before publishing anyway.
 1999-11-18 20:57:36 +00:00
Fred Drake 0d6bf0e544 When generating the top-level index to the documents, make sure some 
oddball things from the LaTeX get translated to rational values.  This
is mostly to keep things from looking broken in a development tree
when they're not.
 1999-11-18 20:56:29 +00:00
Fred Drake 7424242c1c Removed last XXX comment; no further action needed on this one. 1999-11-17 16:09:57 +00:00
Fred Drake 55e93964e6 Preliminary documentation for turtle module (Tk), by Moshe Zadka. 
Fixed up a few TeXisms and markup nits, but otherwise unchanged.
Somewhat raw.
 1999-11-15 17:03:41 +00:00
Fred Drake 2530d4e32b Added request to please not send HTML email to the newsgroup/mailing 
list or to python-docs.
 1999-11-12 17:20:40 +00:00
Fred Drake 29a710f2ef Document \citetitle and \programopt. 1999-11-10 22:51:18 +00:00
Fred Drake 37f1574f2e Use \citetitle and \programopt as appropriate. 1999-11-10 16:21:37 +00:00
Fred Drake e15eb35fd0 Use \citetitle as appropriate. 1999-11-10 16:13:25 +00:00
Fred Drake 9fa76f1090 Use \citetitle in several places, and \programopt where appropriate. 1999-11-10 16:01:43 +00:00
Fred Drake 698d5206aa Use \citetitle in several places. 1999-11-10 15:54:57 +00:00
Fred Drake ebe0341109 Use \citetitle instead of \emph. 1999-11-09 20:11:17 +00:00
Fred Drake 356d0ceb7e Use \citetitle in one place. 1999-11-09 20:10:01 +00:00
Fred Drake 268df27c9a Use the new markup as apporpriate. 1999-11-09 19:45:59 +00:00
Fred Drake 6e9ea59a43 Use \programopt in one place. 1999-11-09 19:44:44 +00:00
Fred Drake 91f31eab1c Added citetitle and programopt. 
Made var get renamed to varname (more like DocBook).
Other names should probably be changed as well; still waiting for the
DocBook book to arrive.
 1999-11-09 19:33:24 +00:00
Fred Drake d290c10890 Use \programopt in one place. 1999-11-09 18:03:00 +00:00
Fred Drake 310ee61f20 Missed a couple of program options that had been marked by \code. 1999-11-09 17:31:42 +00:00
Fred Drake a24f7b759a Use \programopt in one place. 1999-11-09 17:03:45 +00:00
Fred Drake be48646cfa Use \citetitle and \programopt as appropriate. 1999-11-09 17:03:03 +00:00
Fred Drake 7b8195a209 \programopt: New macro, used to mark command-line parameters in the 
text.  Looks like \program.

\citetitle:   New macro, used to mark titles of cited works (like the
              names of the Python manuals).  Accepts & discards an
              optional parameter that is only used by the HTML
              formatter.  Looks like \emph.
 1999-11-09 17:02:11 +00:00
Fred Drake c9f5fe0d1c do_cmd_programopt(): New function, similar to do_cmd_program(). 
do_cmd_citetitle():  New function.  Extracts one optional and one
                     required parameter.  If the optional one is
                     provided, it is used a URL (or relative URL) and
                     the text of the required parameter is turned into
                     a hyperlink.
 1999-11-09 16:59:42 +00:00
Fred Drake 5bd608d46e Change the suggestions pointer at the bottom of generated HTML pages. 1999-10-29 20:51:43 +00:00
Fred Drake c6d45afb1b Straighten out dependencies so changes in the texinputs/* get reflected. 1999-10-29 20:49:23 +00:00
Fred Drake 6cf186b867 pathes --> paths; typo reported by Gerry Wiener <gerry@ucar.edu>. 1999-10-29 17:51:29 +00:00
Fred Drake 5a3194688d Added dependency on filecmp section, removed dependencies on cmp and 
cmpcache sections.
 1999-10-29 17:27:08 +00:00
Fred Drake 47a27b6640 Make references to new filecmp module hyperlinks now that there's 
documentation.
 1999-10-29 17:25:59 +00:00
Fred Drake adf2dbfced Added section for filecmp. 1999-10-29 17:24:12 +00:00
Fred Drake c7b5b3c998 filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>. 1999-10-29 17:23:15 +00:00
Fred Drake 7eaf6828cb Added deprecation notes, in case anyone decides to read these anyway. 1999-10-26 16:31:51 +00:00
Fred Drake 143db4b041 cmp and cmpcache are now obsolete, so don't include their 
documentation sections.
 1999-10-26 16:28:04 +00:00
Fred Drake a8052a3113 Added cmp and cmpcache to the "Obsolete" section. 1999-10-26 16:27:28 +00:00
Fred Drake 714fd26a2f Documented Beep() function. 1999-10-22 21:08:56 +00:00
Fred Drake d6512808f0 Module/script to parse the reference count data file and make the 
information accessible to Python.

When run as a script, just dumps the information back out in the data
format, with functions in sorted order and a blank line between
different functions.

Still need to apply the information somehow.
 1999-10-20 21:50:31 +00:00
Fred Drake 805bf1b330 Added note that Skip created the initial version of this file. 
Fixed up a few of his ??? comments.
 1999-10-20 16:03:38 +00:00
Fred Drake 7b7dc6b49d Initial version as provided by Skip Montanaro <skip@mojam.com>. 1999-10-20 15:06:24 +00:00
Fred Drake 39d4a0237a Fixed typo in explanation of abspath(); noticed by Paul Prescod 
<paul@prescod.net>.
 1999-10-18 14:10:06 +00:00
Fred Drake 532998e00d "make clobber" should remove modindex.html as well. 
Added realclean and distclean as synonyms for clobber.
 1999-09-24 13:51:19 +00:00
Fred Drake 88c786dad9 icons/ should not be ignored here now that this is it's real home. 1999-09-24 13:48:38 +00:00
Fred Drake cf1b06ec47 Added --about option to specify the file to load "About this 
document..." text from, defaulting to ../html/about.dat.
 1999-09-23 16:55:09 +00:00
Fred Drake 8903be62a8 Tell mkhowto to use stdabout.dat for the documents it processes here. 1999-09-23 16:54:06 +00:00
Fred Drake b35f2b7ef8 Remove some <SPAN> elements that were used only to carry a CLASS 
attribute; stick the CLASS on an existing element.

Use a variable for the name of the file to get "About this
document..." text from.
 1999-09-23 16:53:09 +00:00
Fred Drake f62b352a5e Remove the "Comments and Questions" section, allowing this to be used 
for non-standard Python documentation.
 1999-09-23 16:48:54 +00:00
Fred Drake b9bd0b7c82 Version of about.dat that should only be used for the standard 
documentation.
 1999-09-23 16:48:05 +00:00
Fred Drake d37cecfda4 Remove some <SPAN> elements that were used only to carry a CLASS 
attribute; stick the CLASS on an existing element.
 1999-09-23 16:45:08 +00:00
Fred Drake f42d7a78fc Oops, missed this one! 1999-09-23 15:38:14 +00:00
Fred Drake d3d28d39f8 img_tag(): Tighten up the generated SRC attribute a bit; if the image 
relative URL starts with "./", remove "./".
 1999-09-23 15:29:45 +00:00
Fred Drake d52879ccdc do_cmd_rfc(): Simplify the generated markup. 1999-09-22 19:58:51 +00:00
Fred Drake 52ea0ce977 Added --image-type option to allow use of either GIF or PNG images. 
Job.warning():  New method; use this instead of writing to sys.stderr
                directly.  Ensures warnings are also sent to the log
                file.

Job.log():  New method; write a message to the log file.  Use from
            .message() and .warning().
 1999-09-22 19:55:35 +00:00
Fred Drake 191439ab6b Some updates to allow ../tools/mkhowto to add various bits to the 
supplemental l2h initialization file it creates and still get all the
right behavior.  In particular, it can change the image type and icon
location and not get inconsistent results.

Some code to help suppress various navigational pages; this might be
interesting when generating HTML to create HTML Help documents, since
the navigation support creates confusing hits in the full text
search.  HTML Help also provides a lot of the navigational
infrastructure, so duplicating it makes it more tedious to use.
 1999-09-22 19:50:51 +00:00
Fred Drake 3e1a98a336 PNG version of the icons, converted from the GIFs 
by Michael Hudson <mwh21@cam.ac.uk>.
 1999-09-22 14:38:25 +00:00
Fred Drake 0297719180 Added section about where to send comments, questions, & bug reports. 1999-09-21 15:45:06 +00:00
Fred Drake 933d5a7c6e os.name: Note that 'java' is one of the registered names. 1999-09-17 14:38:39 +00:00
Fred Drake e6fb1c4bd3 Added documentation for inet_aton() and inet_ntoa(), from Ben 
Gertzfield <che@debian.org> (with minor changes).

(Should have been here instead of in the branch in the first place,
since these weren't in for the 1.5.2 release.)
 1999-09-16 15:50:00 +00:00
Fred Drake 0ba58158c5 Added "import string" to a couple of examples that describe string 
module functions, to clarify that the import is not automatic.
Suggested by Koray Oner <Koray.Oner@Eng.Sun.COM>.
 1999-09-14 18:00:49 +00:00
Fred Drake 244ad3ca15 Name the parameter to expr() and suite() "source" instead of "string". 1999-09-09 14:16:36 +00:00
Fred Drake 8779f648d2 Added descriptions of the t#, w, and w# PyArg_ParseTuple() format 
characters; these are the ones for the buffer interface.
 1999-08-27 15:28:15 +00:00
Fred Drake 0ee4891c82 Update the instructions slightly. 
Add a new section describing what each of the tools does, in general
terms.
 1999-08-26 18:08:13 +00:00
Fred Drake 4f0279f439 Removed; no longer needed now that the other tools can handle entity 
references directly.
 1999-08-26 18:05:23 +00:00
Fred Drake abb158f56b feed(): Added support for ESIS '&' lines. 1999-08-26 18:04:32 +00:00
Fred Drake 1f33292542 Remove use of fixgenents.sh; no longer needed. 1999-08-26 17:57:18 +00:00
Fred Drake 3cf4eb4e3d Specify: \geq --> &geq; 
\leq    --> &leq;
                \LaTeX  --> LaTeX       (just text)
                \TeX    --> TeX         (just text)
 1999-08-26 17:56:47 +00:00
Fred Drake f6199edcd3 Conversion.subconvert(): Added support for "entityref" parameters 
(must be named in the conversion spec.).

TableParser.start_entityref():  New method.  Use to support creating
        entity references via the conversion specification.
 1999-08-26 17:54:16 +00:00
Fred Drake a20581c1e5 write_esis(): Added support for ENTITY_REFERENCE nodes. 1999-08-26 17:51:56 +00:00
Fred Drake 53eae8e81b convert(): Add support for ESIS '&' lines, and make sure we don't 
silently ignore unrecognized lines.
 1999-08-26 17:50:26 +00:00
Guido van Rossum e7f19200e8 Doco update from Sjoerd Mullender. 1999-08-26 15:57:44 +00:00
Fred Drake 2900ff9382 Added paragraph explaining that except clauses can't be empty; that 
pass can be used if needed.  By Dan Wolfe <wolfeman@apple.com>.
 1999-08-24 22:14:57 +00:00
Fred Drake 4c2533fe3c Added sentence "All exceptions must have an executable block."; from 
Dan Wolfe <wolfeman@apple.com>.
 1999-08-24 22:14:01 +00:00
Fred Drake b68a125d64 Added additional index entries. 
Minor markup nits.
 1999-08-24 20:16:29 +00:00
Fred Drake 76dd228f52 whrandom should come immediately after random, not before. 1999-08-23 20:12:11 +00:00
Fred Drake c924b8d976 Clarified start parameter to Py_CompileString, documented 
Py_eval_input, Py_file_input, and Py_single_input.

Problems reported by Aaron Brancotti <aaron@icona.it>.
 1999-08-23 18:57:25 +00:00
Fred Drake abf8a1daa8 rewrite_descriptor(): Fix bug that dropped the first TEXT node from 
<description> elements.  Add another sanity
                       check to make sure a special case only becomes
                       involved for <opcodedesc> and <opcodedescni>
                       elements.

fixup_paras_helper():  Clean up control flow.

Everywhere that checks node.nodeType==ELEMENT and node.tagName now
just check node.nodeName (nodeName is guaranteed for all node types
and will be special values that don't conflict with GIs for
non-ELEMENT nodes).  Simplifies a number of tests and improves
readability in a lot of places.
 1999-08-20 14:28:29 +00:00
Fred Drake 7eba1d8bbe Tell what the result objects are (based on comment from the list). 1999-08-19 17:00:38 +00:00
Fred Drake 9ed56de752 Added item regarding random/whrandom. 1999-08-19 15:37:35 +00:00
Guido van Rossum b3fc9d148d Added disclaimer to the sleep() function. 1999-08-19 14:42:54 +00:00
Fred Drake 31e5e37196 Explain the possible range of values for the pid parameter to 
waitpid().
 1999-08-13 13:36:33 +00:00
Fred Drake 68921dfa31 In note mentioning [].remove()'s exception, tell what exception is 
raised.  Prompted by Barry's whining.  ;-0
 1999-08-09 17:05:12 +00:00
Fred Drake d3fbdfd007 Add index entries for open(): 
buffer size, I/O
	I/O control, buffering
	line-buffered I/O
	unbuffered I/O
 1999-08-05 13:43:08 +00:00
Fred Drake 8c9fc00f8d Add index entry "I/O control, buffering" for fdopen(). 1999-08-05 13:41:31 +00:00
Fred Drake a94f6762bc Add index entry "I/O control, buffering" for makefile(). 1999-08-05 13:41:04 +00:00
Fred Drake 58c5a2a53c Started documentation on buffer objects & types. Very preliminary. 
Greg Stein:  Please help with this; it's your baby!
 1999-08-04 13:13:24 +00:00
Guido van Rossum 068bdb181d Change the directory tree walking example to use clearer variable 
names, some suggested by Joe Ellsworth.
 1999-08-03 21:52:29 +00:00
Fred Drake 46ab6dfa89 Re-write in Python for portability. About 30% slower, but who cares?! 1999-08-03 17:54:39 +00:00
Fred Drake 82ebc27357 remap_element_names(): Only used for things that the new conversion 
engine in latex2esis.py can do, so discard it.

paragraph detection & markup:  Handle some of the list-like
		environments properly, picking up paragraphs inside
		list items.  (Only changed a few element-sets used for
		recognition.)

fixup_refmodindexes_chunk():  Use the right attribute to determine the
		module a <ref*modindex/> element is referring to.

convert():  Don't call remap_element_names(); it was removed.
 1999-08-03 15:32:48 +00:00
Fred Drake 2f6ec9ca81 The new conversion engine supports more of the table re-writing than 
the old one, so use it.
 1999-08-03 15:27:37 +00:00
Guido van Rossum 32bc45f737 Removed PyMapping_Clear() -- it was wishful thinking and serves no 
great purpose.
 1999-08-02 20:49:37 +00:00
Fred Drake 83c0983bf6 Use the mksourcepgk script instead of mktarball.sh. 1999-08-02 20:20:14 +00:00
Fred Drake 9ff3a6a6e7 Remove obsolete version of script. 1999-08-02 20:19:42 +00:00
Fred Drake 9f2b42080a Re-implementation of mktarball.sh as a more portable Python script; 
with a more descriptive name.

Allow creation of multiple archive formats with a single pass; useful
in this case since it uses a fresh export/checkout from CVS to ensure
that the tree is "clean" (no build turds, saved files, &c).  Use --all
to create all supported formats.
 1999-08-02 20:19:17 +00:00
Fred Drake 080c1b5af6 bwrite(), ewrite(): Helpers for diagnostic output; essentially the 
same as sys.stderr.write(), but bwrite() will make it
		bold if stderr is a tty (for visibility).

		Use these everywhere instead of accessing
		sys.stderr.write() directly.

find_all_child_elements():  Find all elements by type name that are
		immediate children of another.

cleanup_synopses():  Receive both the document and fragment objects as
		parameters; if only the document is passed, synopsis
		information is never found since it's in the fragment!

build_para():	Add a chunk of code to ensure that a newline always
		follows the </para> end-tag.  Not really important, but
		makes presentation consistent for authoring/
		maintenance.

fixup_bifuncindexes_chunk(): Use find_all_child_elements() instead of
		find_all_elements() so we don't work with too many
		levels at once; that could cause DOM exceptions with
		the <elem>.removeChild() method.
 1999-08-02 14:46:15 +00:00
Fred Drake 4fbdf9779c Mostly minor changes. 
Removed some obsolete commented-out code.

Merged BaseConversion into Conversion since there's only one
conversion process now.

Remove push/pop of output stream; it's no longer needed.
 1999-08-02 14:35:25 +00:00
Fred Drake d158b85896 This doesn't need to do nearly as much for the new conversion, so 
simplify.
 1999-08-02 14:32:46 +00:00
Fred Drake 031e222499 A few small improvements to the conversion. 1999-08-02 14:32:11 +00:00
Fred Drake c71b802c47 Markup nits. 
Adjust examples to use the object interface instead of the function
interface.
 1999-08-02 14:30:52 +00:00
Fred Drake ce201128b0 Fixed hyperlink references to the __builtin__ and __main__ modules; 
error reported by Dale Nagata <DNagata@creo.com>.
 1999-08-02 14:13:09 +00:00
Fred Drake eac8abee4e Ripped out the old conversion. 1999-07-29 22:42:27 +00:00
Fred Drake 865e9ff98e Added a few more passes through the document fragment. Not actually 
very interesting.
 1999-07-29 22:23:19 +00:00
Fred Drake 96e4a06fa6 Massive changes. 
Separate the Conversion class into a base and a subclass; the subclass
is pretty minimal but the separation is useful for....

NewConversion:  New class that implements a somewhat different
		approach to the conversion.  This uses a table of
		instances (rather than tuples) that have more
		information than the tuples used for the older
		conversion procedure.  This allows a lot more control
		over the conversion, and it seems to be pretty
		stable.

TableEntry,
Parameter:	New classes that are used to build the conversion
		specification used by NewConversion.

TableParser:	xmllib.XMLParser subclass that builds a conversion
		specification from an XML document.

load_table():	Convenience function that loads a table from a file.

main():  Added flags --new and --old; these select which conversion is
	 used.  The default is --new.

Several fixes have been made in the old conversion as well; these were
done before writing & switching to the new conversion, and should be
archived.

The next checkin of this file will discard the old conversion; is is
kept in this checkin to allow it to be retrieved if needed, and to
avoid lossing the bugfixes that have been made to it in the interim.
 1999-07-29 22:22:13 +00:00
Fred Drake 2394c98c05 Minor updates. 1999-07-29 22:14:09 +00:00
Fred Drake ada2de67b3 Use the (new) buildFragment() method of the EsisBuilder rather than 
implementing it all here.
 1999-07-29 22:13:31 +00:00
Fred Drake f032cdbb24 Some minor cleanup. 1999-07-29 22:03:52 +00:00
Fred Drake bc2285eb60 Conversion specification, used by a new path through latex2esis.py. 
The specific markup conversion is coded here instead of an even more
cryptic table in the code of latex2esis.py.
 1999-07-29 22:03:11 +00:00
Fred Drake 478a265057 Minor update. 1999-07-29 22:01:39 +00:00
Fred Drake c35367e439 Change an {\em ...} to \var{...} and a {\bf ...} to \program{...} (the 
new markup makes sense in context).

These allow the SGML/XML conversion updates to work, & should not have
still been in there anyway.
 1999-07-29 13:56:41 +00:00
Fred Drake 4ef3ea0cc4 Add support for bzip2 compression. 
New target: distfiles, create all distribution archives, regardless of
archive format.  (Individual targets remain for each archive format.)
 1999-07-27 16:30:59 +00:00
Fred Drake 5772f33b6c Add support for bzip2 using --bzip2. 1999-07-27 16:29:30 +00:00
Fred Drake b5213c3010 Ignore additional compressed formats. 1999-07-27 14:23:25 +00:00
Fred Drake 8d21243c3e Added description of optional parameter to UserDict constructor. 
Omission reported by Barry Warsaw.
 1999-07-26 15:45:52 +00:00
Fred Drake 7dcc69a979 Add zip archive support for html, pdf, ps, and latex archives. 
"zips" target produces all possible .zip files.
 1999-07-23 16:11:36 +00:00
Fred Drake 8ea15f3495 Add --zip parameter; make this able to produce .zip files as well as 
.tgz files.
 1999-07-23 16:09:11 +00:00
Fred Drake de5d5ce7bc Update getattr() description to document the optional third 
parameter.  Thanks to Barry Warsaw for pointing out the oversight.
 1999-07-22 19:21:45 +00:00
Fred Drake 06c5a8b52e Make the default target xml instead of sgml. 1999-07-22 13:57:12 +00:00
Fred Drake 7dbde51f97 Make the default target xml instead of sgml. 
Use a temporary file to pass results from latex2esis.py to
docfixer.py; this makes for better error detection by make (if the
first pipeline stage fails, make wasn't catching it).
 1999-07-22 13:56:51 +00:00
Fred Drake 5d48e458e4 typo: privide --> provide 
Reported by Nadim Ghaznavi <nadim@ghaznavi.com>.
 1999-07-20 13:21:42 +00:00
Fred Drake 860e256147 Added comment clarifying that RELEASE is the documentation release 
number, not the Python release.

Removed VERSION since it is not used.
 1999-07-12 16:52:50 +00:00
Fred Drake 6b3fb78ca8 do_cmd_funclineni(): New function; non-indexing form of \funcline. 1999-07-12 16:50:09 +00:00
Fred Drake 6db897c52c Move chdir() and getcwd() descriptions to "Files and Directories" with 
a pointer from the "Process Parameters" section.  Based on comments
from Aahz Maruch, Tim Peters, and GvR.
 1999-07-12 16:49:30 +00:00
Fred Drake f930d827bb Use the same names for CLASS attributes as elsewhere. 1999-07-12 16:28:50 +00:00
Fred Drake bb7eff96d4 Updated Milan's email address. 1999-07-12 15:26:43 +00:00
Fred Drake 3a4ceb707d Several methods return tuples, not lists. 1999-07-07 14:04:38 +00:00
Fred Drake 363d67c2e6 Move some misc. comments from the example section to the main section. 
Use the lowercase versions of the method names in the example, since
that's what's documented (Greg Stein's suggestion).  Add a blank line
after the import line for clarity.
 1999-07-07 13:42:56 +00:00
Fred Drake 1508970a47 dir() method description revised based on comments from Greg Stein. 1999-07-07 13:36:22 +00:00
Fred Drake 6166b871a2 Missing space; reported by Robert Kern <kernr@ncifcrf.gov>. 1999-07-06 21:00:18 +00:00
Fred Drake d5dfe984e7 Fix a number of minor problems pointed out by /F. 1999-07-06 15:50:23 +00:00
Fred Drake 0d6e6e0b39 Fixed typo reported by /F; thanks! 1999-07-06 15:43:55 +00:00
Fred Drake e72d48d5b2 Bump the release number to 1.5.2p1. 1999-07-06 14:30:04 +00:00
Fred Drake 919e74ce88 Darn! Forgot to re-target. 1999-07-02 15:27:14 +00:00
Fred Drake 5a8aaa7542 Remove one item. 
Rearrange & comment on others.
 1999-07-02 14:31:41 +00:00
Fred Drake 82ac24ffb0 Minor markup nit. 1999-07-02 14:29:14 +00:00
Fred Drake 0452007dcc Added entry for asyncore module. 1999-07-02 14:27:03 +00:00
Fred Drake 41796918af Fix a few markup nits, improve some index entries. 1999-07-02 14:25:37 +00:00
Fred Drake 7d80779532 New documentation from Chris Petrilli <petrilli@amber.org>. 1999-07-02 14:25:03 +00:00
Fred Drake 227020894a For spawn*(), point to the magic constants; some readers have a hard 
time finding the bindings.
 1999-07-02 14:01:03 +00:00
Fred Drake e4694eba0f Removed entries for several modules which have been documented. 
Updated comments on several remaining modules.
 1999-07-01 20:42:57 +00:00
Fred Drake 4c8d83f311 Documentation for dl module from Moshe. 1999-07-01 20:40:21 +00:00
Fred Drake 44a7a7c5d0 Added entry for dl module. 1999-07-01 20:39:59 +00:00
Fred Drake 85b5683307 Remove extraneous "contains" -- pointed out by Daniel Barclay 
<danielb@digitalfocus.com>.

Added credit to Martin von Loewis for creating the module and
documentation.
 1999-07-01 16:31:03 +00:00
Fred Drake 859dc53a52 Per Frank Stajano's suggestion, state explicitly that the functions 
described in the sub-sections are directly available at the module
level.  He found this confusing.
 1999-07-01 13:54:40 +00:00
Fred Drake b216060627 Make the reference to the os module in the module synopsis (for the 
table at the front of the chapter) a hyperlink.
 1999-07-01 13:53:32 +00:00
Fred Drake f1ad207f2a Made several grammatical corrections based on comments from Daniel 
Barcla <danielb@digitalfocus.com>.

Also added example of what happens when a parameter is set both
positionally and by a keyword (one of Daniels suggestions related to
that paragraph).
 1999-06-30 15:32:50 +00:00
Fred Drake 3d0971e33e For "Matching vs. Searching", remove comment that the section is 
incomplete; I don't remember what else I thought I was going to put
in, but it looks o.k. to me know.
 1999-06-29 21:21:19 +00:00
Fred Drake 9b59a303a8 Added some reminders. 1999-06-29 18:54:03 +00:00
Fred Drake d85b5a418a Move the setting for secnumdepth to the document classes; make the numbering 
for the manual class go one deeper than it previously did (\subsection
entries will now be numbered); no change for howto documents.

This makes it easier to refer precisely to smaller sections using \ref.
 1999-06-29 18:15:59 +00:00
Fred Drake 6bf37debb9 Added some minor prose before the descriptions of the data attributes 
to make it clear that these are instance attributes, not module data.
 1999-06-29 18:13:37 +00:00
Fred Drake abc64b74c8 Added entry for pty module. 1999-06-29 18:12:22 +00:00
Fred Drake a4b5d58790 pty documentation from Moshe; with small edits. 1999-06-29 18:11:22 +00:00
Fred Drake 31d10cbe26 Improve description of the example. 1999-06-29 17:08:41 +00:00
Fred Drake f5213c2a3d Usage nit: a bunch of "nor"s should have been a single "or". 
Make reference to the copy_reg module a hyperlink.
 1999-06-29 16:02:12 +00:00
Fred Drake 8ad2703bfb Minor wording change in section title. 1999-06-29 16:00:22 +00:00
Fred Drake ac00c4c1c6 byteswap() method: Tell *what* exception gets raised when the type 
cannot be byteswapped.
 1999-06-29 15:58:00 +00:00
Fred Drake 9118f7cfc4 Remove unnecessary comma. 1999-06-29 15:53:52 +00:00
Fred Drake 9e0b6229f6 Comment out XXX comment; this needn't appear in the formatted 
versions.  XXX comments only need to be grep-able.
 1999-06-29 15:45:09 +00:00
Fred Drake ef1a029d4c Add note about not being able to use this module with modules not 
implemented in Python.
 1999-06-29 15:43:02 +00:00
Fred Drake 4886c66daf Moshe: Remove extraneous "and". 1999-06-29 14:57:12 +00:00
Fred Drake e4d78189e8 Added entries for mutex and nis modules. 1999-06-27 15:02:37 +00:00
Fred Drake 7fefba5c13 NIS documentation from Moshe. 1999-06-27 15:01:08 +00:00
Fred Drake 2231357aa6 Mutex documentation from Moshe. 1999-06-27 15:00:41 +00:00
Fred Drake 7a65a26f81 Separate documentation of SUNAUDIODEV from sunaudiodev; this mirrors 
similar constructs elsewhere (al/AL, gl/GL/DEVICE).
 1999-06-27 14:53:11 +00:00
Fred Drake 14ae4b48fb Fix some typos. 
Add an index entry.
 1999-06-25 19:13:36 +00:00
Fred Drake c4e3bf9b5e Add entries for the sched module. 1999-06-25 18:54:30 +00:00
Fred Drake 7e990323b4 Moshe's section on the sched module, with edits. 1999-06-25 18:52:44 +00:00
Fred Drake 60b66e1f7b Update to Sjoerd's documentation of the chunk module, with some 
additions from Moshe's version.  Used my table for describing the
chunk format, and added some markup and index entries.
 1999-06-25 17:52:17 +00:00
Guido van Rossum cf6905f986 Clarify the example by explicitly importing the fcntl module -- this 
avoid being fooled into thinking that fcntl and FCNTL are the same
thing -- they aren't!  (fcntl is the extension, FCNTL.py is h2py
output that defines all the constants).

(XXX The example is still weird -- I think there's a more portable way
to do locking now.  That's for someone else to fix...)
 1999-06-24 17:58:44 +00:00
Fred Drake 7c2426439e Removed tty module entry. 1999-06-23 17:31:59 +00:00
Fred Drake 1b2dc9045e Add entries for tty module. 1999-06-23 17:29:02 +00:00
Fred Drake 0bccd73be0 Updates from Moshe, again edited by me. Describe the parameters to 
border() using a table instead of text for ease of comprehension.
 1999-06-23 17:28:01 +00:00
Fred Drake 92f3f41424 Added "See Also" section for termios module. 1999-06-23 15:12:09 +00:00
Fred Drake ae4d5c23f5 Various updates. 1999-06-23 14:56:13 +00:00
Fred Drake 66239d5530 tty module documentation from Moshe, with some editing and an added 
"See also" section.
 1999-06-23 14:30:19 +00:00
Fred Drake af81a509c3 Added more sections... 1999-06-23 13:34:22 +00:00
Fred Drake b742a42bc0 Two more from Moshe! 1999-06-23 13:33:40 +00:00
Fred Drake 707f8e67b9 Added entry for the chunk module. 1999-06-22 18:50:06 +00:00
Fred Drake 97793ab6b9 New section from Moshe Zadka, modified by FLD for markup, some 
additional content.
 1999-06-22 18:49:20 +00:00
Fred Drake 0f871dc39e Added some "See also" references to htmllib docs. 
Documented htmlentitydefs.
 1999-06-21 21:20:56 +00:00
Fred Drake 2cd31dc3ea Added entry for curses module. 1999-06-21 21:14:30 +00:00
Fred Drake 4997f4d54a Added entries for four of Moshe's documentation sections. 1999-06-21 21:13:50 +00:00
Fred Drake a4070cef5e Preliminary documentation for the curses module by Moshe Zadka, with 
lots of markup fixes and some English nits fixed.

Still needs real review.  Some of the function signatures used in this
module are really bad!  (Two leading optional parameters? Ugh!)
 1999-06-21 21:13:09 +00:00
Fred Drake d5d55ea02e Fix a markup error. 1999-06-21 18:36:09 +00:00
Fred Drake 4755e7d5c1 Three more modules documented by Moshe! 1999-06-21 18:25:49 +00:00
Fred Drake 6f49e0a154 Added a few minor comments, mostly to discourage documentation of 
really old modules that may become obsolete.
 1999-06-18 19:58:59 +00:00
Fred Drake a48a083edb Added paragraph about potential re-initialization of extension 
modules; responding to suggestion by Robin Boerdijk
<Robin.Boerdijk@nl.origin-it.com>.
 1999-06-18 19:17:28 +00:00
Fred Drake a88ef00a50 Further clarfication of the system-dependence of the system() return 
value, based on comments from Tim Peters.
 1999-06-18 19:11:25 +00:00
Fred Drake 46e1a32edf Re-categorize the dump module as obsolete. 1999-06-18 17:12:15 +00:00
Fred Drake 354e98222c fpformat has been documented for at least a week now! 1999-06-18 15:21:25 +00:00
Fred Drake 26921da2c9 Small markup & usage adjustments. 1999-06-17 18:58:02 +00:00
Fred Drake 924b42de9c When looking for things that might be modules, include *module.c from 
the Modules/ directory.  Most of the remaining undocumented modules
seem to be living there.
 1999-06-17 18:49:18 +00:00
Fred Drake e019789962 Correction: the parameters of new.instance() are type-checked. 
Edited several of the descriptions for English usage and more
consistent style.
 1999-06-17 18:15:07 +00:00
Fred Drake de69ae1753 Updated version from Moshe, with a re-written warning about the 
side-effect of cmpcache.cmp() using statcache.stat() internally.
 1999-06-17 17:40:52 +00:00
Fred Drake 173ba5e3bc Minor markup nits. 1999-06-17 17:09:23 +00:00
Fred Drake 97c2fa03e5 Small English usage nits. 1999-06-17 16:38:18 +00:00
Fred Drake 7487c02209 Small markup and English usage nits. 1999-06-17 16:10:39 +00:00
Fred Drake 873f0297c3 Add reminder that wave.open() documentation should be updated for the 
next Python release.
 1999-06-17 15:20:44 +00:00
Fred Drake 551d2b14e7 Add entries due to additional sections from Moshe. 1999-06-17 15:12:50 +00:00
Fred Drake 26da2840ac Add/remove entries due to additional sections from Moshe. 1999-06-17 15:12:16 +00:00
Fred Drake 64bc94e3ec New module documentation sections from Moshe Zadka <moshez@math.huji.ac.il>! 1999-06-17 15:11:35 +00:00
Fred Drake e55702b024 Added note to __not__() description that this operation is defined 
only by the interpreter core and is not overridable by objects.

Based on comment from David Ascher on the list.
 1999-06-15 20:56:40 +00:00
Fred Drake 1e4402998f Several new index entries to make find this easier. 
Noted that name=value is allowed in addition to name: value.
 1999-06-15 17:30:59 +00:00
Fred Drake 42120eaca5 Added entries for new sections from Moshe. 1999-06-14 19:52:10 +00:00
Fred Drake c46864e982 Misc. changes related to the new sections. 1999-06-14 19:49:50 +00:00
Fred Drake 21572fdcb6 New sections from Moshe Zadka <moshez@math.huji.ac.il>. 
These document CGIHTTPServer, SimpleHTTPServer, and linecache.
 1999-06-14 19:47:47 +00:00
Fred Drake 7df4dd7de2 Add entry for the fpformat module. 1999-06-11 18:36:42 +00:00
Fred Drake 1739d2f9ee Documentation for the fpformat module by Moshe Zadka 
<mzadka@geocities.com>.
 1999-06-11 18:31:00 +00:00
Fred Drake 2f9790195b Added 'ce' to the list of "registered" values for os.name. 
Make references to the posix module hyperlinks.
 1999-06-11 18:28:37 +00:00
Fred Drake 5eb992beed Last night's scribbles: 
- Revise abstract based on Guido's comments from way back.
- Point out that LaTeX is a structured system & we're using it that
  way.
- Add a small section on marking up code examples.
 1999-06-11 14:25:45 +00:00
Fred Drake 9c5cc14d23 Some clarifications on operations for mapping types, based on comments 
from Gerry Weiner <gerry@ucar.edu>.
 1999-06-10 22:37:34 +00:00
Fred Drake 697c779d98 Adjust indexing for __import__(); based on comments by Stefan Franke 
<sfranke@cdc-group.com>.
 1999-06-10 22:09:20 +00:00
Fred Drake 28b1770521 Improve index entry for "import"; responding to comments by Stefan 
Franke <sfranke@cdc-group.com>.
 1999-06-10 22:08:16 +00:00
Fred Drake 06a73f042a Work around latex2html problem; reported by Gerrit Holl 
<gerrit.holl@pobox.com>.
 1999-06-10 21:23:31 +00:00
Fred Drake 4d5c87ba11 Declare the "util" module obsolete. 1999-06-10 21:17:11 +00:00
Fred Drake f64f8a0877 Fixed typo reported by Bennett Benson 
<BennettBenson@mn.mediaone.net>.
 1999-06-10 15:30:21 +00:00
Fred Drake 7a62128722 At David Ascher's request, clarify that os.system() always returns 0 
on Win95 & Win98.
 1999-06-10 15:07:05 +00:00
Fred Drake ae0f292576 Fix typo reported by Robert Kern <kernr@ncifcrf.gov>. 1999-06-10 15:03:07 +00:00
Guido van Rossum 66ab4e8af2 Patch by Jim Fulton to document the new parse_qls(). 1999-06-10 03:11:41 +00:00
Guido van Rossum 4727456d46 Add doc for timegm(). 1999-06-09 15:11:58 +00:00
Fred Drake 5fac2ab220 Fix availability clause; mention availability of similar functionality 
for Windows using win32pipe.
 1999-06-01 17:55:52 +00:00
Fred Drake f1882422d2 Oops, forgot to remove the individual module indexes for lib & mac now 
that there's a Global Module Index; there can be only one!
 1999-05-27 21:56:11 +00:00
Fred Drake 3c27ec2c05 Add <hr> after top navigation bar; now looks more like the rest of the 
navigation bars in the HTML output.
 1999-05-27 21:52:51 +00:00
Fred Drake d2a727feee Hack: make sure LaTeX2HTML doesn't change -- to - in mkhowto 
description.
 1999-05-27 21:45:54 +00:00
Fred Drake 3aa70d63b9 Document the "pid" attribute of the Popen3 class. 
Use memberdesc instead of datadesc to document object attributes.
This gets the index right.
 1999-05-27 17:50:59 +00:00
Fred Drake a7ce52b03a Typo reported by Gerry Wiener <wiener@rap.ucar.edu>: 
items -> item

The returned list will then have one more items than the number of
non-overlapping occurrences of the separator in the string.
 1999-05-27 17:18:08 +00:00
Fred Drake abc8cc63ce Move some \index entries around so we can avoid using empty comments; 
empty comments trigger a bug in LaTeX2HTML.

Problem reported by Gerry Wiener <gerry@ucar.edu>.
 1999-05-26 16:15:17 +00:00
Fred Drake 82f355a36a Change the example of configuring for large file support under Solaris 
to use `getconf LFS_CFLAGS`.  Steve Clift (the author of the section
and large file support) agrees that this is the right thing to do.
 1999-05-26 13:03:34 +00:00
Fred Drake 6b330ba857 "proces" --> "process"; reported by Gerry Wiener <gerry@ucar.edu>. 
Added some index entries.
 1999-05-25 13:42:26 +00:00
Fred Drake 0eb7b2a659 Enhanced docstring and some comments. 
_begin_macro_rx:  Fixed RE that didn't properly allow a space after
		  the name of the macro.  This affects the conversion
		  of the tutorial.
 1999-05-19 17:37:37 +00:00
Fred Drake c4811d8208 Modify to perform "---" to "&mdash;" conversion outside of 
verbatim-like environments.  The list of verbatim-like environments is
a defined by a variable in main().
 1999-05-18 17:34:51 +00:00
Fred Drake c41e1e5f5e Remove the "---" to "&mdash;" conversion; this is wrong in verbatim 
environments.  Move the conversion to esis2sgml.py.
 1999-05-18 17:33:01 +00:00
Fred Drake 338da93734 SET_LINE_NO ==> SET_LINENO 
Reported by Corran Webster <cwebster@math.tamu.edu>.
 1999-05-17 20:57:07 +00:00
Fred Drake 33378da964 Added paragraph explaininng the text/binary flavors of some methods, 
to make it easier for people to find what they're looking for.
 1999-05-17 16:35:15 +00:00
Fred Drake d1fb77970d Document \e, \url. 
Add a few more comments about mkhowto.

Based on comments from Albert <hat@se-46.wpa.wtb.tue.nl>.
 1999-05-17 16:33:54 +00:00
Fred Drake 4f52867d95 Don't \input boilerplate.tex, fill in the real stuff. 3rd party 
documents probably aren't written by Guido.  ;-)
 1999-05-17 16:02:38 +00:00
Fred Drake 87f768e20b Attempted to clarify usage of the \declaremodule macro somewhat; 
Michael Hudson's documentation for bytecodehacks exhibits incorrect
usage.

Added some comments about how to set up the mkhowto script for use
with documents not contained in the documentation source tree.
 1999-05-17 15:22:45 +00:00
Fred Drake 3e4c614c16 define_module(): Check the module type for validity before using. 
This reflects the changes made in
		  ../texinputs/python.sty.
 1999-05-17 15:00:32 +00:00
Fred Drake 66823029a4 \declaremodule: Typo. 1999-05-17 14:57:26 +00:00
Fred Drake 5bc8d99bce \declaremodule: Make this more robust. Only attempt to add an index 
entry based on the module type if the type is known.
		 Otherwise, spit out a warning the the module type
		 parameter was bad and generate a "plain" index entry.

		 Without this, the bad module type was emitted as
		 text.

Problem noticed by processing Michael Hudson's docs for
bytecodehacks.
 1999-05-17 14:47:10 +00:00
Fred Drake 8ee593cb46 The conversion temporary files should not be ignored here anymore, 
since they shouldn't be here.  Only ignore the output tarballs in this
directory.
 1999-05-13 18:57:28 +00:00
Fred Drake dbc2d08ff5 POP3.uidl(): Update description based on comments from Piers Lauder 
<piers@cs.su.oz.au>.
 1999-05-13 18:48:14 +00:00
Fred Drake dab44682c2 PyCObject_FromVoidPtr(): Clarify that the destr function will only be 
called on destruction is non-NULL.
 1999-05-13 18:41:14 +00:00
Fred Drake 431f0ce547 Small nits around some of the index entries. 
When refering to chapters, use \ref, don't hardcode the chapter
number.
 1999-05-13 18:38:11 +00:00
Fred Drake ab03215204 make_index_entry(): Remove. Not only did this override the 
l2hinit.perl version of the function (which
		     overrode a version in latex2html), but
		     do_cmd_index() was overridden.  Since
		     do_cmd_index() was the only caller, we can trash
		     this.

define_indexing_macro():  New function used during setup to support
			  more dynamic dispatch for indexing.

process_index_macros():  New function; implement dynamic dispatching
			 of indexing support functions, allowing many
			 targets used in indexing to be shared by
			 multiple index entries.  I.e., something like
			 \index{foo}\bifuncindex{bar} can now share a
			 single target anchor.

These indexing changes reduce the amount of clutter in the generated
HTML files.  In the reference manual, this cuts the number of targets
by 44%.  Targets are less affected when generated by environments
rather than macros.
 1999-05-13 18:36:54 +00:00
Fred Drake 76febdf3fd make_index_entry(): Remove. This is overridden in python.perl and 
was never called in this incarnation.  The
		     other version is simpler as well.
 1999-05-13 16:41:19 +00:00
Fred Drake 7088df4c56 Removed old comments. 1999-05-13 16:20:30 +00:00
Fred Drake 84bd6f3b18 Change the look of \seemodule output to fit in better. 1999-05-11 15:42:51 +00:00
Fred Drake 03c05a5192 Move the "See also:" section so it appears are part of the top HTML 
page of the section.
 1999-05-11 15:15:54 +00:00
Fred Drake 184e8360e8 Added module references; minor grammatical fixes. 
All suggested by Eric Raymond.
 1999-05-11 15:14:15 +00:00
Fred Drake 9ade7e0110 Added missing comma, reported by Eric Raymond. 1999-05-11 13:45:37 +00:00