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

1852 Commits

Author SHA1 Message Date
Fred Drake ed13b4a5a6 Break the "Python Services" chapter into two: "Python Runtime Services" 
(still at the start of the manual), and "Python Language Services" (late
in the manual).  Moved "Restricted Execution" to just before "Python
Language Services."
 2000-08-03 21:18:18 +00:00
Fred Drake 8b168ba505 int() description: Fix markup to avoid image generation for math mode. 
zip() description:  Fix broken markup, three small markup consistency nits,
	and one really minor usage nit.  Introduce use of \moreargs instead
	of hardcoding "..." with \optional.
 2000-08-03 17:29:13 +00:00
Barry Warsaw faefa2a885 Both PEP 201 Lockstep Iteration and SF patch #101030 have been 
accepted by the BDFL.

Added documentation for zip() builtin.
 2000-08-03 15:46:17 +00:00
Fred Drake 6c7a46a2f0 Rob Hooft <rob@hooft.net>: 
Description of fcntl():  Added description of what can go wrong.
 2000-08-02 20:53:51 +00:00
Mark Hammond 21a4764b9a As requested by Fred - mention that in the future a winreg module may make a comeback. 2000-08-01 23:49:50 +00:00
Peter Schneider-Kamp f917bf6080 fixing a minor spelling mistake 2000-08-01 00:07:17 +00:00
Fred Drake fbd3b45bb7 Stop lying about [].pop() being experimental! There is no backing it out 
at this point.
 2000-07-31 23:42:23 +00:00
Peter Schneider-Kamp 5a65c2d436 added count, extend, index, pop and remove to arraymodule 2000-07-31 20:52:21 +00:00
Fred Drake 1e75e1776f Two minor nits from Gerry Weiner (no working email address) about 
describing the methods of dictionaries.
 2000-07-31 16:34:46 +00:00
Fred Drake 578a3f9638 Moshe Zadka <mzadka@geocities.com>: 
Document new method in shutil (copyfileobj).
Minor clarification by Fred.
 2000-07-31 15:45:46 +00:00
Fred Drake 10853c9835 Finally fixed the much-reported bug about "~" in a couple of example. 
This time, it was reported by Skip.
 2000-07-28 13:51:27 +00:00
Eric S. Raymond b924bd4610 Second round of curses documentation improvements. Completes and extends 
documentation for function keys, special characters.
 2000-07-27 21:10:02 +00:00
Andrew M. Kuchling 1962fb59f3 Document tiget{flag,num,str} 2000-07-26 02:59:13 +00:00
Fred Drake e1b304db37 Fix small typos and markup consistency nits. 2000-07-24 19:35:52 +00:00
Eric S. Raymond 6899660a81 First round of curses documentation improvements; correct errors, flesh out 
entry point descriptions.
 2000-07-24 03:28:40 +00:00
Skip Montanaro d372521ec0 added doc for isatty() 2000-07-19 17:30:58 +00:00
Skip Montanaro 7cb1524586 added documentation for new functions {get,set}_history_length 2000-07-19 16:56:26 +00:00
Thomas Wouters f8316638af Rob W. W. Hooft's spelling fixes for the Library Reference. I hope 
SourceForge doesn't choke on this batch :-)

I'm not entirely sure this is 100% correct. The patch changes an
\index{persistency} to \index{presistence}, and I don't know what \index{}
does. But it seems to do so persi--er, consistently, so I hope it isn't a
problem.
 2000-07-16 19:01:10 +00:00
Eric S. Raymond f868de6491 Document the second round of ConfigParser changes. 2000-07-14 15:00:02 +00:00
Andrew M. Kuchling 8d2f2b2db2 From Sam Rushing's Medusa, via SF patch #100858: add & document 
os.seteuid(), os.setegid(), os.setreuid(), os.setregid().
 2000-07-13 01:26:58 +00:00
Fred Drake bdcf91fda0 Documentation for the gc module. Text from Neil Schemenauer 
<nascheme@enme.ucalgary.ca>, markup & minor revisions from Fred
Drake.
 2000-07-12 04:22:53 +00:00
Eric S. Raymond 7ae3a5e79d Resynchronize the TeX docs with (a) the module docstring, and (b) my recent 
fix to the code to make it behave like the module docstring.
 2000-07-12 02:56:15 +00:00
Fred Drake acab3d61e9 Change the table in the pyexpat.errors module to a series of datadesc 
elements (since the table was pretty screwed up); this is how it is done
elsewhere in the manual.

I could use some help creating descriptions of the specific error
identifiers (input conditions that lead to each error, etc.).
 2000-07-11 16:30:30 +00:00
Eric S. Raymond 417c489def Give ConfigParser the capability to set as well as read options, and to write 
a representation of the configuration state in .ini format that can be read
back in by a future read() call.  Thus this class is now a back end
for .ini editors as well as parsers.

This patch is complete and tested, but exposes a bug in the ConfigParser
implementation which I have not yet fixed.  Because case information is
discarded during parsing, the output of write() has its case smashed.

I wrote this for a SourceForge interface script called forgetool.
Documentation for the new entry points included.
 2000-07-10 18:11:00 +00:00
Fred Drake 146b28086f Minor revisions similar to some information in the new docstrings. 2000-07-08 16:59:03 +00:00
Fred Drake c826ecbf8f Add an entry for the KDE File Manager support from Peter Funk. 2000-07-07 17:08:40 +00:00
Fred Drake e4dbb86ab8 New module webbrowser. Easy-to-use controller objects to make using a 
Web browser as a help/information browser easy across platforms.
 2000-07-07 03:36:12 +00:00
Fred Drake aa7524cf1f Clean up markup to be more like recommended practice; only small changes 
needed.
 2000-07-06 18:37:08 +00:00
Fred Drake 29fa30ea6b Correct a markup nit that caused a space to be dropped from the HTML 
version (actually a LaTeX2HTML bug), and clarified a sentence in the
mktime() description based entirely on comments from Grant Griffin
<grant.griffin@honeywell.com>.
 2000-07-06 18:09:02 +00:00
Fred Drake 3c62d9e656 Several small changes, mostly to the markup, to improve consistency and 
internal hyperlinking.  Move some things around, also for consistency
with other modules ("See also" stuff tends to live at the \section level,
before sub-sections, etc.).
 2000-07-06 04:51:04 +00:00
Fred Drake 14ea85f325 Add entry for readline documentation. 2000-07-06 04:47:25 +00:00
Fred Drake 011028cf74 Sjoerd Mullender <sjoerd@oratrix.nl>: 
Updates for recent changes in xmllib.
 2000-07-06 04:45:14 +00:00
Fred Drake d14423abe2 Correct typo in description of the machine name parameter to the 
ConnectRegistry() function; there is no trailing period!
 2000-07-06 04:38:37 +00:00
Skip Montanaro 63099f911f added seealso pointing reader at readline example which uses atexit. 2000-07-06 03:26:39 +00:00
Skip Montanaro 510ca1d338 simple-minded readline section doc based upon module's doc strings. 2000-07-06 03:25:26 +00:00
Skip Montanaro 0915165096 added warning about incompatibility with other codes' use of sys.exitfunc. 2000-07-05 23:11:26 +00:00
Fred Drake b5316188ee Created a new chapter on structured markup processing, including the 
existing SGML, HTML, & XML support, and providing a home for the new
XML support as it becomes documented.
 2000-07-05 02:24:39 +00:00
Fred Drake c05cbb0527 Wrapped some long lines. 
Cleaned up the table of error constants defined in pyexpat.errors; an
extra pair of braces had pretty much destroyed the table!  (Not sure why.)
Moved the pyexpat.errors module documentation into a \section with the
proper headers for a module.
 2000-07-05 02:03:34 +00:00
Fred Drake 25e7cee1c8 get_starttag_text(): Document this method. 2000-07-03 14:32:04 +00:00
Fred Drake 52dc76c81f Eric S. Raymond <esr@thyrsus.com>: 
This patch implements relative-path semantics for the "source" facility resembling
those of cpp(1), documents the change, and improves the shlex test main to
make it easier to test this feature.  Along the way, it fixes a name error
in the existing docs.

[Additional documentation markup changes for consistency by FLD.]
 2000-07-03 09:56:23 +00:00
Fred Drake 353aaadd9b Moshe Zadka <moshez@math.huji.ac.il>: 
Substantial updates to reflect Moshe's Gordon's enhancements to the
module.

Additional changes from Fred to reflect his changes to the module as well.
 2000-07-03 08:24:49 +00:00
Fred Drake fcc95a4d04 Tim-blessed documentation for math.frexp(). 2000-07-03 06:38:17 +00:00
Fred Drake c3a65982a3 others --> other's (possessive) 
Usage error noted by Grant Griffin <grant.griffin@iowegian.com>.
 2000-07-01 17:47:38 +00:00
Fred Drake 506a7a87ff Send a "ARTICLE" --> Send an "ARTICLE" 
Usage error noted by Grant Griffin <grant.griffin@iowegian.com>.
 2000-07-01 17:43:19 +00:00
Fred Drake 30f76ffd00 Update version numbering from 1.6 to 2.0. 2000-06-30 16:06:19 +00:00
Fred Drake f0e88980f3 Document randrange(). 2000-06-30 15:32:31 +00:00
Fred Drake 57a2f7f8ef Change description of altzone to not refer to the "0th meridian". 2000-06-30 04:24:52 +00:00
Fred Drake 9a748aa832 Say "manual page", not "man page", when referring to the Unix manual. 2000-06-30 04:21:41 +00:00
Fred Drake abbc7344a4 Make sure to note that this module was added for Python 2.0! 2000-06-30 03:50:06 +00:00
Fred Drake 6e71cdd9f1 Reflect the name change to _winreg; we still need documentation for the 
new winreg module.
 2000-06-30 03:45:40 +00:00
Andrew M. Kuchling efc43d4478 Document recently-added mouse-related functions 2000-06-30 01:05:39 +00:00
Fred Drake 8aa3bd9098 Make it clear that id() can return either a long integer or a plain integer. 2000-06-29 03:46:46 +00:00
Fred Drake 5c529d3f3e Add a "See also:" link to the curses.ascii module. 2000-06-28 22:11:40 +00:00
Fred Drake 589f44b9d0 Made the title of the Examples subsection plural! 2000-06-28 22:09:20 +00:00
Fred Drake be93a8332e Added note that the atexit module was added for Python 1.6. 2000-06-28 22:07:55 +00:00
Fred Drake 6f2a5efec9 Added entry for the curses.ascii module. 2000-06-28 22:05:44 +00:00
Fred Drake 5ccd4b2a54 Added entries for the curses.ascii module. 2000-06-28 22:03:29 +00:00
Fred Drake 4e716fa0ac Skip Montanaro <skip@mojam.com>: 
Added an example of using an HTTP POST request.
 2000-06-28 21:51:43 +00:00
Fred Drake c82634c13c Thomas Wouters <thomas@xs4all.net>: 
Documentation updates related to the addition of openpty() and forkpty().
 2000-06-28 17:27:48 +00:00
Fred Drake c19425d520 Added the atexit module and documentation from Skip Montanaro 
<skip@mojam.com>.  Revisions to the markup to make it pass LaTeX, added
an index entry and a reference from the sys.exitfunc documentation.

This closes SourceForge patch #100620.
 2000-06-28 15:07:31 +00:00
Andrew M. Kuchling af5b76677f Changed obsolete e-mail alias 2000-06-27 03:16:04 +00:00
Andrew M. Kuchling f57d7b9e30 Dcoumentation for ascii.py. I've changed two references from ascii to 
curses.ascii.
 2000-06-26 23:59:24 +00:00
Andrew M. Kuchling a4ca07cc8c Minor grammatical fix 2000-06-21 01:48:46 +00:00
Andrew M. Kuchling d24ff44f06 Document .timeout() method and .typeahead() function 2000-06-21 01:42:51 +00:00
Andrew M. Kuchling 0adfb45b9a Make changes and clarifications suggested by Mark Hammond 2000-06-18 04:17:38 +00:00
Andrew M. Kuchling b8050697b8 Documentation for the mmap module: proofreaders welcomed 2000-06-17 22:39:05 +00:00
Fred Drake 9e759dfc31 Michael Hudson <mwh21@cam.ac.uk>: 
This patch corrects a little glitch and two outright errors.

(Including one reported earlier by Thomas Wouters.)
 2000-06-15 18:44:30 +00:00
Fred Drake fb79ffae4d Hook in the documentation for the unicodedata module. 2000-06-13 20:51:29 +00:00
Fred Drake 28b294459d Marc-Andre Lemburg <mal@lemburg.com>: 
Documentation for the unicodedata module (massaged by Fred for minor
consistency issues).
 2000-06-13 20:50:50 +00:00
Andrew M. Kuchling 6b14eebae6 Documentation for the pyexpat module. 2000-06-11 02:42:07 +00:00
Fred Drake d1a65ff40b Added preliminary documentation for the winreg module, 
by Mark Hammond <markh@activestate.com>.

Limited markup & consistency revisions by FLD.
 2000-06-07 04:07:48 +00:00
Fred Drake 6c16019136 Fixed typo noted by Guido Kollerie <gkoller@cs.vu.nl> in example code. 2000-05-30 14:39:45 +00:00
Fred Drake b80a777859 Added documentation for gettempprefix(). 
Deprecated direct access to template.
Added note about past need to modify template so that legacy code has a
better chance of being understood, noting that the requirement to reset
template after os.fork() disappeared in 1.5.2.
 2000-05-26 19:32:14 +00:00
Fred Drake 0233075fce Added documentation for TemporaryFile() and the siffix parameter to mktemp(). 
Removed obsolete comments about this module not creating or removing actual
files.
Removed obsolete comment about users needing to set template to None after
calling os.fork().
 2000-05-26 19:05:16 +00:00
Fred Drake 99d707af47 Piers Lauder <piers@cs.su.oz.au>: 
I've added an extra comment about quoting arguments to
IMAP4 commands. Also changed the command descriptions
to show optional extra commands where appropriate.

Fred Drake:
Added example usage for the search() method based on comments from
<Lucas.DeJonge@awtpl.com.au>; elaborated error handling information
when arguments are missing from search() and uid().
 2000-05-26 04:08:37 +00:00
Andrew M. Kuchling f1dc5fa2c8 Updated docs to list all the new methods and functions. The docs are 
now complete, but probably still not very helpful or friendly.

Note: two very large tables (of key names, and of character names) were
added; these tables format terribly, and need some reworking.
 2000-05-23 16:46:04 +00:00
Fred Drake 7cb42cd070 From Greg Ward <gward@python.net>: 
Typo:  "dictionairy" --> "dictionary" (twice).
 2000-05-23 02:28:26 +00:00
Fred Drake 8c5cedee69 New description for math.frexp() -- poor description noted by 
Francois Pinard.
 2000-05-18 05:07:38 +00:00
Guido van Rossum c9a5f343bc The addition of rint() (by Peter Schneider-Kamp; I forgot to mention 
that before) in the previous patch has one problem; rint() is not in
the C math library on all platforms (e.g. not for VC++).  Make it
conditional on HAVE_RINT.
 2000-05-11 18:42:27 +00:00
Guido van Rossum 71260b846e Added math.rint() -- round according to current IEEE754 mode 2000-05-11 18:19:42 +00:00
Fred Drake 625d70a7a6 Fix references to the built-in compile() that don't include the 
filename parameter.  Noted by Randall Hopper <aa8vb@yahoo.com>.
 2000-05-09 17:10:23 +00:00
Fred Drake 35784dff6a Skip Montanaro <skip@mojam.com>: 
The intent is that this diff adds a link to the rfc822 module doc and
an index reference to this module under the rfc822 heading.

Fred, based on a suggestion from Grant Griffin <grant.griffin@honeywell.com>:
Added link to the MIME FAQ, so people can more easily get more
information about the subject of the module.
 2000-05-09 16:23:23 +00:00
Fred Drake d85f05940e read() method: clarify that strings are accepted and interpreted 
reasonably.

readfp() method:  added documentation.
 2000-05-09 15:06:32 +00:00
Fred Drake 3d69c0e440 Someone found the examples of poor practice on socket addresses! 
Spotted by Greg Kochanski <gpk@bell-labs.com>.
 2000-05-03 19:40:32 +00:00
Fred Drake ae08853fb0 Clarify status of connection of a new instance; it *is* connected if 
you pass server information to the constructor.  Error noted by Pedro
Diaz Jimenez <diazjimenez@ctv.es>.
 2000-05-03 15:11:47 +00:00
Fred Drake e06d025e00 Use \versionchanged to indicate when the second parameter to utime() 
was allowed to be None.
 2000-05-02 17:29:35 +00:00
Guido van Rossum d67ddbbec1 Eric Raymond: 
(1) Added and documented the capability for shlex to handle
lexical-level inclusion and a stack of input sources.  Also, the input
stream member is now documented, and the constructor takes an optional
source-filename.  The class provides facilities to generate error
messages that track file and line number.

(2) Add a convenience function to generate C-compiler style error
leaders.
 2000-05-01 20:14:47 +00:00
Barry Warsaw 93a8eacde5 Document the new additional signature for utime(). In addition to the 
previous functionality utime(path, (atime, mtime)), now allowed is
utime(path, None) which sets the file's times to the current time.
 2000-05-01 16:18:22 +00:00
Fred Drake 40ee7acb95 \file and \filenq should not be used in section titles; they are not 
sufficiently robust to survive the creation of bookmarks in the PDF
format.
 2000-04-28 18:17:23 +00:00
Fred Drake ac308d0a6f Added a "See also:" section that exhibits the \seerfc markup. 2000-04-26 18:20:04 +00:00
Fred Drake cebda6f5f0 Added documentation for WindowsError; omission noted by Michal Bozon 
<bozon@natur.cuni.cz>.

(Mark Hammond, other Python/Windows cognoscenti: please check this!)
 2000-04-17 17:42:00 +00:00
Fred Drake 9cf7587fdc Update change to version_info structure. 2000-04-13 17:51:58 +00:00
Fred Drake 4d65d73686 Document hexversion (incompletely explained) and version_info (easily 
explained).
 2000-04-13 16:54:17 +00:00
Fred Drake ee775a194c Make use of \longprogramopt where appropriate. 2000-04-11 19:46:40 +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 9164f88657 Fix Skip's email address in his attribution! (Thanks, Skip!) 2000-04-08 04:53:29 +00:00
Fred Drake c2c46c3751 New example from Skip Montanaro <skip@mojam.com>. 2000-04-07 16:09:59 +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 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 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 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 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 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 a22b576d05 UserString class from Peter Funk <pf@artcom-gmbh.de>. 2000-04-03 03:51:50 +00:00
Fred Drake 3c9f936eee Two new sections. Preliminary. 2000-03-31 17:51:10 +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
Fred Drake 0baf773c44 Added entry for libtabnanny.tex. 2000-02-23 15:44:58 +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 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 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 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 37f1574f2e Use \citetitle and \programopt as appropriate. 1999-11-10 16:21:37 +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 d290c10890 Use \programopt in one place. 1999-11-09 18:03:00 +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 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 39d4a0237a Fixed typo in explanation of abspath(); noticed by Paul Prescod 
<paul@prescod.net>.
 1999-10-18 14:10: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 244ad3ca15 Name the parameter to expr() and suite() "source" instead of "string". 1999-09-09 14:16:36 +00:00
Guido van Rossum e7f19200e8 Doco update from Sjoerd Mullender. 1999-08-26 15:57:44 +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 7eba1d8bbe Tell what the result objects are (based on comment from the list). 1999-08-19 17:00:38 +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
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 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 8d21243c3e Added description of optional parameter to UserDict constructor. 
Omission reported by Barry Warsaw.
 1999-07-26 15:45:52 +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 5d48e458e4 typo: privide --> provide 
Reported by Nadim Ghaznavi <nadim@ghaznavi.com>.
 1999-07-20 13:21:42 +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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 7088df4c56 Removed old comments. 1999-05-13 16:20:30 +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
Fred Drake b0bc7f2d6c Updated connect_ex() documentation based on comments in the newgroup 
(M.-A. Lemburg and GvR).
 1999-05-06 22:03:50 +00:00
Fred Drake 1ea7c75687 Reflect recent patch for float % and divmod() by Tim Peters. Content 
updates by Tim Peters, markup by FLD.
 1999-05-06 14:46:35 +00:00
Fred Drake 673c65e500 Use the new module-key for the FL module when hyperlinking (the old 
one caused problems on case-insensitive file systems).
 1999-04-29 18:42:18 +00:00
Fred Drake d03e9e34de Don't point readers to rand, point to random! And make it a hyperlink 
while you're at it.

Also, when discussing order of reading, make it clear that chapter 2
is assumed background material for the remainder of the manual.
That's needed for terminology if nothing else!
 1999-04-29 13:41:17 +00:00
Fred Drake 0e1de8bd6b Minor nits, partly in response to comments from Jonathan Black 
<jblack@Ridgeway-Sys.com>.
 1999-04-29 12:57:32 +00:00
Fred Drake 5f342ac2a7 Always use "section" when referring to sections of a document, not "Section". 1999-04-29 02:47:40 +00:00
Fred Drake c0fcbc1ac6 Update starship URLs. 1999-04-29 02:30:04 +00:00
Fred Drake ea0020571f Use \rfc to mark some remaining RFC references. 
Remove comment about full name bug in getaddrlist(); this has been
fixed for a while now.

Work around LaTeX2HTML space-dropping bug.

Mention that the fp attribute can be used to read the message body.
 1999-04-28 18:11:09 +00:00
Fred Drake 505c49199a Added "See also" reference to PyOpenGL. 1999-04-27 18:05:06 +00:00
Fred Drake dcf17f3860 mhlib is now documented. 1999-04-23 22:24:12 +00:00
Fred Drake a4966647ec Markup consistency. 1999-04-23 22:22:27 +00:00
Fred Drake 1c7cd63a2b Nits. 1999-04-23 22:03:00 +00:00
Fred Drake 957ac3fadb Add section for the sha module. 1999-04-23 21:52:18 +00:00
Fred Drake 154fc6dcf7 Patch from Greg Ward adding descriptions of S_IMODE() and S_IFMT(), 
and an explanation of why any of stat.S_*() would be used instead of
os.path.is*().  (With some really small enhancements by me.)
 1999-04-23 20:54:57 +00:00
Fred Drake 24aca83dbd Fixed typo and font-control problem reported by Detlef Lannert 
<lannert@lannert.rz.uni-duesseldorf.de>.
 1999-04-23 20:33:59 +00:00
Fred Drake 29cf682b71 Clarifications on the first(), next(), and previous() functions, based 
on comments from Detlef Lannert <lannert@lannert.rz.uni-duesseldorf.de>.
 1999-04-23 20:32:59 +00:00
Fred Drake 861192120b Fix a grammatical error reported by Detlef Lannert 
<lannert@lannert.rz.uni-duesseldorf.de>.
 1999-04-23 20:07:02 +00:00
Fred Drake 16214fb017 Fix a couple of grammatical errors reported by Detlef Lannert 
<lannert@lannert.rz.uni-duesseldorf.de>.
 1999-04-23 20:00:53 +00:00
Fred Drake 4aa4f30759 Work-around LaTeX2HTML space-dropping bug. 1999-04-23 17:30:40 +00:00
Fred Drake 87b8f318b0 Fixed some logical markup nits. 
Added a pointer to Grail in the see-also section, since it's used as
an example.
 1999-04-23 17:26:24 +00:00
Fred Drake deb7e096d3 Logical markup. 1999-04-23 17:11:53 +00:00
Fred Drake 806764bee4 No, __repr__() does not accept a parameter other than self. 1999-04-23 17:03:21 +00:00
Fred Drake 0fbec55e23 Shorten the section title. 
Adjust markup to be a little more consistent with the rest of the
document.
 1999-04-23 16:44:53 +00:00
Fred Drake eea97ea063 Shorten the section title. 1999-04-23 16:07:38 +00:00
Fred Drake 86bd5e48c3 Shorten the section title. 
Fix a couple of grammatical errors.
 1999-04-23 16:02:30 +00:00
Fred Drake 7475e04fad Work around a space-dropping problem in LaTeX2HTML. 
Clarify the usage of a parameter.
 1999-04-23 15:57:23 +00:00
Fred Drake ae35aa8b63 Added "See also" sections linking to binascii. 1999-04-23 15:52:18 +00:00
Fred Drake ee4d54ea33 Refer to the binhex module, not the non-existent hexbin module. 
Added a "See also" section.
 1999-04-23 15:42:36 +00:00
Fred Drake 26f7cfe9c7 Fix some glaring markup consistency problems (presentation was 
broken).

Added a "See also" section.
 1999-04-23 15:41:53 +00:00
Fred Drake 812860e81d Hack places where '--' should appear as literal output but the -- was 
(properly) converted to - by LaTeX2HTML.
 1999-04-23 14:46:18 +00:00
Fred Drake ffbe68723a Make internal module references hyperlinks wherever it makes sense. 1999-04-22 21:23:22 +00:00
Fred Drake 7b8b125fa6 Remove bogus characters in code sample. 1999-04-22 21:19:53 +00:00
Fred Drake fcf94d4edd Work around LaTeX2HTML comment-handling bug. 1999-04-22 20:55:59 +00:00
Fred Drake 4a406c619b Shorten the section title. 1999-04-22 20:52:44 +00:00
Fred Drake c8c40ff699 Added a "See also" section with some external references. 1999-04-22 20:16:02 +00:00
Fred Drake 4e28c593ad Markup nits. 
Make module references hyperlinks.
 1999-04-22 18:25:47 +00:00
Fred Drake b7168c3a07 Clean up lots of mark up. 1999-04-22 17:53:37 +00:00
Fred Drake 79936fe73f Added descriptions of the various exceptions, based on the docstrings. 
Various small cleanups.
 1999-04-22 17:23:34 +00:00
Fred Drake c8993aad10 Logical markup and small nits. 
Don't refer to the STDWIN chapter; chances are really good it wasn't
included.  ;-)
 1999-04-22 16:50:40 +00:00
Fred Drake 12a956921f Make some module references hyperlinks. 1999-04-22 16:47:27 +00:00
Fred Drake b774550ba5 Minor logical markup nits. 
Make some module references hyperlinks.
 1999-04-22 16:46:18 +00:00
Fred Drake dd6c6d9b0a Clean up some mark up. 1999-04-22 16:45:26 +00:00
Fred Drake e2effbd32d Fix minor (English) usage nits. 1999-04-22 16:21:09 +00:00
Fred Drake bcd5454d63 Reference to urllib module can be a hyperlink. 1999-04-22 16:17:45 +00:00
Fred Drake 4429772ea3 Fix dropped space in the HTML output. 1999-04-22 16:15:34 +00:00
Fred Drake babdda53d5 Make reference to the socket module a hyperlink. 1999-04-22 16:03:30 +00:00
Fred Drake bf0f4346af Shorten the section title. 1999-04-22 15:53:35 +00:00
Fred Drake 47894d2858 Don't describe this module as being a popen() wrapper; that's a little 
confusing.  This is clearly Unix-specific; label it as such.
 1999-04-22 15:19:01 +00:00
Fred Drake a694e00085 Remove \platform declaration; this module is generic. 1999-04-22 15:14:11 +00:00
Fred Drake 5254a6d682 Move stat to the Generic chapter. 1999-04-22 15:01:44 +00:00
Fred Drake ca69a03dd6 Don't refer to the system documentation as "man pages"; too 
Unix-centric.  Note that this can be used with the output of
os.fstat() as well as os.stat() and os.lstat().
 1999-04-22 14:55:43 +00:00
Fred Drake 2ea30f4d8c Add warning that last() and previous() don't work for hashtable 
databases (opened using hashopen()), as noted by Skip Montanaro on
comp.lang.python.
 1999-04-22 14:06:36 +00:00
Fred Drake b9f1f6d90b Misc. markup nits. 
All sections get reasonable file names in the HTML output.
 1999-04-21 21:43:17 +00:00
Fred Drake 2dabd811cd Fix markup typo. 1999-04-21 21:33:24 +00:00
Fred Drake d146edfaf1 Mark the "Notes:" sections under tables the same way it's done 
elsewhere in the library reference.
 1999-04-21 21:15:35 +00:00
Fred Drake b11d108cdc The version information here was checked good in 1999, not 199. ;-) 
Added "See also" reference to zlib home page, even though it's
mentioned in the text.
 1999-04-21 18:44:41 +00:00
Fred Drake 2799f9d09a Reflow paragraph to work around LaTeX2HTML dropping a space. 
Make all references to the os module hyperlinks.
 1999-04-21 18:33:47 +00:00
Fred Drake 6d20caa2ce Reflow paragraph to work around LaTeX2HTML dropping a space. 1999-04-21 18:17:11 +00:00
Fred Drake 543e19d923 Small nits, more hyperlinks. 
Added more information for cStringIO.
 1999-04-21 18:15:22 +00:00
Fred Drake 048b75bd9a Make references to whrandom hyperlinks. 1999-04-21 18:14:22 +00:00
Fred Drake ec6baaf618 Small markup nits. 1999-04-21 18:13:31 +00:00
Fred Drake 54f2fdd1ad Make the names of the referenced modules hyperlinks; they had not been 
marked at all.
 1999-04-21 18:10:08 +00:00
Fred Drake 02e8c0fd2d Nits. Reference to signal module becomes a hyperlink. 1999-04-21 18:01:14 +00:00
Fred Drake 283c588402 Work around LaTeX2HTML comment-handling bug. 1999-04-21 17:57:15 +00:00
Fred Drake 318c0b131f Logical markup nits. 
Make references to other modules hyperlinks.
 1999-04-21 17:29:14 +00:00
Fred Drake c3845a14d3 Logical markup & other small nits. 1999-04-21 17:18:04 +00:00
Fred Drake 11bc8cfee3 Explain *why* the copytree() implementation is presented as the 
example!
 1999-04-21 17:08:51 +00:00
Fred Drake e688aec707 Textual references to the glob module can be hyperlinks. 1999-04-21 17:04:43 +00:00
Fred Drake 737aa552f4 Markup nit to fixed dropped space in HTML output. 1999-04-21 17:01:15 +00:00
Fred Drake 4747f7f61d Markup nits. 1999-04-21 16:41:40 +00:00
Fred Drake 4f6e4fbc1d Added "See also" reference to xdrlib. 
Markup nits.
 1999-04-21 16:38:53 +00:00
Fred Drake 69fa56327a Markup nits. 1999-04-21 16:29:57 +00:00
Fred Drake 8307e21a2a Mark the references to module names use \module or \refmodule (the 
closing paragraph used \code).
 1999-04-21 16:29:18 +00:00
Guido van Rossum 6ed122a334 Important fix mentioned by The Dragon De Monsyne: the sendmail() 
method does _not_ disconnect the connection when it throws a
SMTPHeloError!
 1999-04-21 16:19:16 +00:00
Fred Drake a889add5d6 Oops; minor nit in example: none of the other interactive examples 
show the "trailing" prompt, so don't show it here!
 1999-04-21 16:00:24 +00:00
Fred Drake 3d815bd1c7 Added link to xdrlib module in "See also" section. 1999-04-21 15:57:29 +00:00
Fred Drake c3fcd6fa0e Added index entry for "file objects"; this is appearantly referenced 
somewhere in the Reference Manual, and someone tried to locate it via
the index.  Report on the omission by Stefan Franke
<sfranke@cdc-group.com>.
 1999-04-21 13:58:17 +00:00
Fred Drake 7ceb5777d7 Added doc for the "module" attribute on the class descriptor objects; 
omission repoorted by Glyn Webster <glyn@ninz.org.nz>.
 1999-04-20 18:18:53 +00:00
Fred Drake ad56dafd62 Added example use of pack_list() to help explain the pack_item 
parameter.  Lack of clarity reported by Matthew Gallagher
<hew@hons.cs.usyd.edu.au>.
 1999-04-20 13:41:14 +00:00
Fred Drake 4ae52694c9 Updated to reflect additions. 1999-04-19 21:21:28 +00:00
Fred Drake 32c562bdec colorsys docs from David Ascher. 1999-04-19 21:20:13 +00:00
Fred Drake 9d15881744 bsddb docs from Skip Montanaro; added interesting links. 1999-04-19 21:19:21 +00:00
Fred Drake e9af64c373 Remove superfluous index entry for posix.popen(); no longer 
appropriate since popen() is only documented in os.
 1999-04-16 19:00:48 +00:00
Fred Drake dac9a4e3db Added link to Fredrik Lundh's online Tkinter reference material. 1999-04-16 18:26:22 +00:00
Fred Drake 31bfbc6bff Minor nits, include author info. 1999-04-16 14:03:32 +00:00
Fred Drake 0ebd5483be Removed dbhash from the undocumented list. 1999-04-15 16:05:29 +00:00
Fred Drake 666255f5ac Document the dbhash module, and link to it from appropriate places. 1999-04-15 15:11:40 +00:00
Fred Drake f4cbada3f9 Correct documentation for <file>.read(); Python makes a serious 
best-effort to return 'size' bytes.  Point out that this may mean
multiple fread() calls.  Reported by Anders Hammarquist
<iko@iko.pp.se> via the Debian crew.
 1999-04-14 14:31:53 +00:00
Fred Drake e331356ff7 Fix availability declaration for popen2 module; report by Barry Scott 
<barry@scottb.demon.co.uk>.
 1999-04-13 22:03:26 +00:00
Fred Drake b9971b9964 Minor cleanup. 1999-04-13 21:39:31 +00:00
Fred Drake 592dd78408 Fix availability declaration for stat module; report by Barry Scott 
<barry@scottb.demon.co.uk>.
 1999-04-13 21:38:02 +00:00
Fred Drake 31ec33ed60 Work around problems with HTML conversion by making the break and 
tbreak synopses be all on one line (each).  Known problem, most
recently reported by Barry Scott <barry@scottb.demon.co.uk>.
 1999-04-13 21:36:44 +00:00
Fred Drake bfb092eb86 Misspellling: "occurance" --> "occurrence" 1999-04-09 19:57:09 +00:00
Guido van Rossum 7969f31c4d Updated documentation by Per Cederqvist. I've added back the 
documentation sendmail() to reflect the changes by The Dragon
(see smtplib.py checkin).
 1999-04-07 15:56:51 +00:00
Fred Drake 4f21d54764 Added more "See also" entries, + 1 inline hyperlink. 1999-04-05 22:18:12 +00:00
Fred Drake ea003fcc2a Fixed latex2html weirdness with footnotes. 1999-04-05 21:59:15 +00:00
Jeremy Hylton 45b0aeda3c correct version info for zlib. 
add note about module failing with old versions of the library.

update comment that explains that this doc is *still* out of date
 1999-04-05 21:55:21 +00:00
Fred Drake 9aa8543c84 open() description: Made it more clear that 'b' should always be 
added to the mode value for binary files to improve
	portability.

Fixed latex2html weirdness with a couple of footnotes.
 1999-04-05 21:22:41 +00:00
Fred Drake 01553706bf Added a few items to the "See also" sections at Guido's prompting. Made 
more references to other modules in the text hyperlinks for the HTML and
PDF versions.
 1999-04-05 19:46:21 +00:00
Fred Drake 50ae47b0de Removed bosities around example code; not sure where that stuff crept 
in!
 1999-04-05 19:26:16 +00:00
Fred Drake 1dc3a501a6 Made improvements based on changes just made and comments from 
Bernhard Reiter <bernhard@csd.uwm.edu>.
 1999-04-05 19:00:54 +00:00
Fred Drake 806a467fbf Where rfc822.Message is mentioned, add a link to the rfc822 module. 1999-03-27 05:45:46 +00:00
Guido van Rossum cb1f2420ea Document complex() with string arg. 1999-03-25 21:23:26 +00:00
Guido van Rossum 5fc9c869dd SIGTERM is no longer caught to call sys.exitfunc. 
This change was made long ago but the documentation was never updated.
 1999-03-25 20:30:00 +00:00
Fred Drake e82f5b3d6e Added note about ftpmirror.py, since that seems to be one of the most 
requested Python tools/examples.
 1999-03-25 05:04:17 +00:00
Guido van Rossum 8be229650d Document new builtin buffer(). Greg Stein. 1999-03-19 19:10:14 +00:00
Fred Drake 596766772e Documented FTP.set_pasv(). 1999-03-18 16:08:54 +00:00
Fred Drake 154d909993 Note that abspath() was added in 1.5.2. 1999-03-17 22:25:11 +00:00
Fred Drake 8d2c0c2ab4 Fixed minor nits, added index entries to make these easier to find for people 
not familiar with Unix terminology.
 1999-03-16 16:40:01 +00:00
Fred Drake 658cef0141 Preliminary mhlib and telnetlib documents from Skip Montanaro -- thanks, Skip! 1999-03-15 15:44:18 +00:00
Fred Drake bf5a6d2eb4 Fixed tons of small markup problems. 1999-03-12 19:57:38 +00:00
Fred Drake b3a20bc44c Added availabililty annotations to respond to concerns of /F. 1999-03-12 18:34:21 +00:00
Fred Drake 93503ca57b Fixup the module keys. There were some problems with hosting / processing 
file HTML files on Windows machines do to case insensitivity.
 1999-03-12 16:24:22 +00:00
Fred Drake be110c1706 Updates based on comments from /F. 1999-03-12 15:27:35 +00:00
Fred Drake 35c3ffdc3f Fixed description of WSTOPSIG(), added WTERMSIG(). Problem reported 
by Jonathan Giddy <jon@dgs.monash.edu.au>.
 1999-03-04 14:08:10 +00:00
Fred Drake a54a887f66 "\platform{UNIX}" should really be spelled "\platform{Unix}". 1999-03-02 17:03:42 +00:00
Fred Drake f6863c1909 Added \platform annotations. 1999-03-02 16:37:17 +00:00
Fred Drake 43b34da656 extract_tb(): Only describe this function once. Problem reported by 
Jonathan Giddy <jon@dgs.monash.edu.au>.
 1999-02-26 18:51:21 +00:00
Fred Drake 390636382a Typo: "Availabilty" --> "Availability" 
Thanks to /F!
 1999-02-26 14:05:02 +00:00
Fred Drake 51027c4173 Added note about comments, from Christopher Petrilli. 1999-02-24 22:36:44 +00:00
Fred Drake 16e81f4484 Update some of the top comments and shorten title of the first 
section.
 1999-02-24 19:57:14 +00:00
Barry Warsaw f2b4554403 Document the correct class hierarchy for SystemExit. It is not an 
error and so it derives from Exception and not SystemError.
 1999-02-24 00:27:14 +00:00
Fred Drake 1ec71cb556 Incorporated updates to describe geturl() by Sjoerd Mullender 
<Sjoerd.Mullender@cwi.nl>.
 1999-02-22 22:42:14 +00:00
Fred Drake 00a3a65cc0 Refer to the right RFC in the intro. 1999-02-22 17:12:42 +00:00
Fred Drake 7d9b13325d Other chapter titles refer to collections of modules as "Services"; do 
the same here.
 1999-02-22 14:48:00 +00:00
Fred Drake fab41f1788 BabylMailbox description: Properly escape the backslashes in the 
string representations.
 1999-02-22 14:26:16 +00:00
Fred Drake b63e77ccb0 Oops, used a \label twice - fix one of them. 1999-02-22 14:14:48 +00:00
Fred Drake 180b68b3cf More reasonable section titles. 1999-02-22 13:45:09 +00:00
Fred Drake 76991ec75a Shorten section title. 1999-02-20 05:20:49 +00:00
Fred Drake 199b79c37b Added descriptions for BabylMailbox and Maildir (Qmail) mailbox 
objects.
 1999-02-20 05:04:59 +00:00
Fred Drake 67d229ea76 Shorten section title. 1999-02-20 04:51:16 +00:00
Fred Drake bbac43223c Shorten a few section titles. 1999-02-20 00:14:17 +00:00
Fred Drake da57365337 Give subsections reasonable file names in the HTML. 1999-02-19 23:48:05 +00:00
Fred Drake 342501142d Added an index entry. 1999-02-19 23:45:06 +00:00
Fred Drake 56f8185a53 Shortened the short synopsis -- too long. 1999-02-19 22:59:56 +00:00
Fred Drake 9f03380d1c Use more current approach to recording authors. 1999-02-19 22:56:08 +00:00
Fred Drake c60047575d Shortened the short synopsis -- way too long. 1999-02-19 22:33:51 +00:00
Fred Drake d8a41e6391 Fix an amazing number of typos & malformed sentences reported by Detlef 
Lannert <lannert@uni-duesseldorf.de>.
 1999-02-19 17:54:10 +00:00
Fred Drake f6346345b0 Noted that the module was added in 1.5.2. 1999-02-19 15:46:38 +00:00
Fred Drake 4e7c205470 Update description of what modules "look like" when printed. 1999-02-19 15:30:25 +00:00
Fred Drake cd71aa2a38 Use current approach to record documentation author. 1999-02-18 21:13:03 +00:00
Fred Drake 2a2f1fe4d5 Record module & documentation author. 1999-02-18 21:10:32 +00:00
Fred Drake 6b103f1e12 Documentation for pyclbr and tokenize modules. 1999-02-18 21:06:50 +00:00
Fred Drake 4d358b5d23 Added sections for pyclbr and tokenize. 1999-02-18 20:40:26 +00:00
Fred Drake 7c829b3179 Remove the "Parsing Python" section. Hurray! 1999-02-18 20:39:44 +00:00
Fred Drake 70a66c9d6d Add notes to __builtin__.float() and string.atof() that the NaN and Inf 
results are possible but non-portable.
 1999-02-18 16:08:36 +00:00
Fred Drake 951eea4733 atof() description: Add information about accepting 'NaN' to produce 
the NaN value.
 1999-02-18 03:49:20 +00:00
Fred Drake 85a59dd68b The _O_* constants are defined as O_* in the os module. 1999-02-16 19:41:01 +00:00
Fred Drake 9329e5ec75 Remove "_" from the P_* symbols used with the spawn*() functions. 1999-02-16 19:40:19 +00:00
Fred Drake c7b72dbbca Added chapter on Windows modules, including msvcrt and winsound. 1999-02-16 19:18:38 +00:00
Fred Drake aa1afa8d30 Added availability notes for samefile(), sameopenfile(), samestat() 
since these are not available on Windows.
 1999-02-15 16:34:00 +00:00
Fred Drake 9474d86242 Make sure all HTML pages generated from this section have reasonable 
names.

Markup nits.
 1999-02-12 22:05:33 +00:00
Fred Drake 2d2b6a0074 Markup nits. 1999-02-12 20:40:49 +00:00
Fred Drake 28bc711f5f Added section for MimeWriter, contributed by Christopher Petrilli 
<petrilli@amber.org>.

This spells the end of another whole section in the undoc chapter!
 1999-02-12 19:26:09 +00:00
Fred Drake 26b698fa4d Document <complex #>.conjugate(). 1999-02-12 18:27:31 +00:00
Guido van Rossum ce67f06491 Update documentation to reflect changes to Queue.py by Tim Peters. 1999-02-08 18:43:13 +00:00
Fred Drake d673d481f5 Document sameopenfile(), samestat(). 1999-02-03 22:31:30 +00:00
Fred Drake 0256c1f453 Document splitdrive(). 
For all split*(), these split path *into* pairs, not split path *in*
pairs.  "Into" can be used for transformations, "in" is for
containment.
 1999-02-03 19:24:44 +00:00
Guido van Rossum 0c9608cf1b Portability fix for [f]statvfs() return tuple: no longer return the 
f_fsid field, since it's not a scalar on all systems supporting this
call (in particular, it's a tuple of two longs on AIX).  Since it's
not particularly useful, just nuke it.  Adapted the doc strings too.
 1999-02-03 16:32:37 +00:00
Fred Drake 215fe2f204 Fix the os/posix documentation issue. 1999-02-02 19:02:35 +00:00
Fred Drake dda199b261 Moved \versionadded to end of description sections. 1999-02-02 19:01:37 +00:00
Fred Drake 12ba7868e4 Moved posixpath to os.path. 1999-02-02 19:00:37 +00:00
Fred Drake 560bcae0f0 Added posixpath, winsound. 1999-02-02 18:59:58 +00:00
Fred Drake a9b9bf96fe Change this to be os.path. 
Use consistent parameter naming with the os documentation (paths
always named "path" or "path1", "path2"...).
 1999-02-02 18:58:33 +00:00
Fred Drake d0bceeeb59 Move \versionadded macros to end of descriptions. 1999-02-02 18:00:40 +00:00
Guido van Rossum 09da65ef2f Patch by Sjoerd Mullender to placate /F: 
Clarified (hopefully :-) the documentation of elements and attributes
variables.
 1999-02-02 17:55:12 +00:00
Fred Drake dbd72a4e4f Added module synopsis. 1999-02-01 21:27:59 +00:00
Fred Drake 68a8c69499 Take out just about everything and refer the reader to the os module. 1999-02-01 20:23:02 +00:00
Fred Drake b23ee1d899 Make the text generic, and call it os.path instead of posixpath. 1999-02-01 20:20:39 +00:00
Fred Drake 98be47e737 OSError description: "as the by the" --> "as the" 1999-02-01 16:17:40 +00:00
Guido van Rossum 1804dc3c07 Document abspath() (implementation is forthcoming). 1999-01-29 18:05:05 +00:00
Fred Drake 703b70e260 Added \modulesynopsis. 1999-01-28 19:30:49 +00:00
Fred Drake 9d814c6805 Document the repr module. This removes the entire "Code objects and 
files, debugger etc." section from "Undocumented Modules"!
 1999-01-27 17:20:33 +00:00
Fred Drake da452bf6a7 Don't say that the module defines the "following functions" and then 
only describe one; say "following function" instead!

Merge the two one-sentence paragraphs into a single paragraph, so it
doesn't look too stupid.
 1999-01-27 15:48:23 +00:00
Fred Drake ebe2a12de8 Incorporate changes for patched version of ConfigParser. 1999-01-26 21:49:05 +00:00
Fred Drake bc866ce2e3 Documentation for the ConfigParser module, by Christopher G. Petrilli 
(petrilli@amber.org).
 1999-01-26 15:47:59 +00:00
Guido van Rossum 9700e9becc Document the default for tabsize in expandtabs(). 1999-01-25 22:31:53 +00:00
Fred Drake 19a0dba342 Add caveat on partial dependence on the "cl" module, only available on 
IRIX systems.
 1999-01-20 16:26:09 +00:00
Fred Drake 9ea3e36419 Move the jpeg module to the SGI section; it is dependent on the "cl" 
module available on IRIX.
 1999-01-20 15:55:20 +00:00
Fred Drake a7998f650a Revised comments on null bytes in pattern string. 
Removed "New" from module synopsis.
 1999-01-19 20:00:08 +00:00
Fred Drake 6ffa445832 Fix second description of handling 2-digit years (last item in 
introductory text).
 1999-01-19 19:35:18 +00:00
Fred Drake 7eca8e5017 Fix typo spotted by Jeff MacDonald <jam@ans.net>. 1999-01-18 15:46:02 +00:00
Barry Warsaw 53610caee2 for method getaddrlist(): Added a note clarifying that all named 
headers and their continuation lines are parsed.
 1999-01-14 21:26:54 +00:00
Fred Drake e36e4e6778 Use \refmodule when we say "use the XXX module instead". 
For the whatsound module, point to sndhdr.
 1999-01-13 17:11:52 +00:00