Commit Graph

1114 Commits

Author SHA1 Message Date
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
Fred Drake 39cddb7439 Added \modulesynopsis. 1999-01-12 19:22:11 +00:00
Fred Drake 03dd3efd5a <writer>.send_paragraph(): Clarify what needs to be done by this
method and what it should not do.  (Specifically: handling
	breaking of last line of preceeding paragraph.)
1999-01-12 18:33:47 +00:00
Fred Drake bb3b0028ba Patches describing the statvfs() and fstatvfs() functions. Additional
text about large file support.

All new text by Steve Clift <clift@mail.anacapa.net>, with only minor
revision / addition of markup.
1999-01-11 18:36:23 +00:00
Fred Drake c7dd3e11da Markup nit.
Add module synopsis.
1999-01-07 15:45:55 +00:00
Guido van Rossum cf3ce92ef4 Explain how come that pickle and cPickle, while using the same data
format, can produce different pickle strings for the same object.
1999-01-06 23:34:39 +00:00
Guido van Rossum 87e611e441 Replace the docs for reduce with an adaptation of its docstring, which
was actually clearer!
1999-01-06 23:10:51 +00:00
Guido van Rossum 74429eacb5 Add doc for access() and ttyname(). Patch by Sean Reifschneider. 1999-01-06 23:03:43 +00:00
Fred Drake c553358c63 Remove documentation for whatraw() since it's gone now. 1999-01-06 15:21:19 +00:00
Fred Drake 60adb362df Document the sndhdr module.
Document that the whatsound module is obsolete.
1999-01-05 23:09:12 +00:00
Fred Drake a2e4017394 Shorten the synopsis that gets into the table of contents. 1999-01-05 22:54:49 +00:00
Fred Drake 02e18b4b84 Added missing "from" in IOError description. 1999-01-05 21:42:18 +00:00
Andrew M. Kuchling f07c328c07 Document the optional mode argument (Z_FLUSH, Z_SYNC_FLUSH, etc.)
to the flush() method of compressor objects.
1998-12-31 21:14:23 +00:00
Fred Drake 94c4a7976f Added index entries to make it easier to locate directory & file operations. 1998-12-28 21:58:57 +00:00
Fred Drake 8692998018 Added index entries to make it easier to locate directory operations. 1998-12-28 21:58:15 +00:00
Fred Drake 76fa3b73d6 Remove recently documented modules from the undoc list. 1998-12-28 20:53:19 +00:00
Fred Drake 449e18f459 Add documentation for shutil module. 1998-12-28 20:16:58 +00:00
Fred Drake cd058539a8 Adjust a few niggles that affected the HTML conversion (a couple of
"^"s were being dropped in the context of [^...]).
1998-12-28 19:03:24 +00:00
Fred Drake 99e2c39b31 Add the getpass module. 1998-12-22 23:37:46 +00:00
Fred Drake 5ac2a07fca Basic documentation for the getpass module. 1998-12-22 23:37:21 +00:00
Fred Drake 5cb48a4c98 Added a \versionchanged since the API changed to support
namespaces with 1.5.2.

Added an index entry.

Fixed XML expansion:  XML is the "Extensible Markup Language", not the
"eXtended Markup Language".
1998-12-22 18:46:13 +00:00
Fred Drake 292b9ebfba Added information on when this was added, allowing us to release the
documentation on the Web while people are still using < 1.5.2b1.
1998-12-22 18:40:50 +00:00
Fred Drake 1189fa98eb Adjust markup to match current conventions, and make it formattable. 1998-12-22 18:24:13 +00:00
Fred Drake 768ac6b804 Start of text that describes differences between match and search.
Strengthen pointers to the search() function and method.
1998-12-22 18:19:45 +00:00
Fred Drake 191f2857f5 Use \moduleauthor and \sectionauthor instead of a comment to credit
the author (just happened to notice this one).
1998-12-22 18:06:02 +00:00
Fred Drake 7be0cde3a0 Add an explanation about what the example does and doesn't do.
Fix an appearantly new behavior with latex2html with quoting.  (Good
incentive to work on the SGML conversion! ;)
1998-12-22 18:04:48 +00:00
Guido van Rossum 5e97c9dff9 Adding libshlex and libnetrc by Eric Raymond. 1998-12-22 05:18:24 +00:00
Fred Drake e848976fba Clarify descriptions of some operations; it's not always clear that
strings are not actually modified.  Problem reported by Dr. Peter
Stoehr <peter.stoehr@weihenstephan.org>.
1998-12-21 18:56:13 +00:00
Fred Drake 3b02ddfa41 Add a bunch of index entries related to retrieving information from
the process table.
1998-12-21 18:52:53 +00:00
Guido van Rossum b083a9fb54 Sjoerd Mullender writes:
Here is my current version of xmllib.py and the documentation.  This
version has some API changes with respect to the version currently in
Python (also the one in 1.5.2a).
This version supports XML namespaces.
1998-12-18 20:17:13 +00:00
Fred Drake fee6abea90 Remove another {\rm ...} construct.
Sheesh, where do these things come from?
1998-12-10 19:57:52 +00:00
Fred Drake e9e05968e3 Nits. 1998-12-10 05:04:21 +00:00
Fred Drake 0ad55fb241 Update the descriptions of strftime() and strptime() to avoid
confusion, and describe what the "directives" are about.
1998-12-08 19:59:36 +00:00
Guido van Rossum aac399b80b Correct the poplib example. Stephan Richter pointed out some problems
with it.
1998-12-08 16:30:10 +00:00
Fred Drake 64583d3f87 Rename the parameters of atan2(), based on comments from Guido & Peter
A. Koren <pkoren@hex.net>.
1998-12-08 16:10:44 +00:00
Guido van Rossum f484a3366b Sjoerd writes:
When literal mode is entered it should exit automatically when the
matching close tag of the last unclosed open tag is encountered.  This
patch fixes this.
1998-12-07 21:59:56 +00:00
Fred Drake d83675f344 "singed" --> "signed" (3 places)
Noticed by Andrew MacIntyre <andymac@bullseye.apana.org.au>.
1998-12-07 17:13:18 +00:00
Guido van Rossum 8c2da61811 Add explicit example on how to import a submodule of a package using
__import__ and getattr().
1998-12-04 15:32:17 +00:00
Barry Warsaw 6d26f4b188 Moved NotImplementedError into alphabetical order, and reword
description.
1998-12-01 19:48:04 +00:00
Barry Warsaw 1e151322fb Added documentation for NotImplementedError. Fred (I'm sure) will
sanitize for your protection :-)
1998-12-01 19:19:21 +00:00
Fred Drake 2f8592cbea Ignore the byproducts of SGML/XML conversions for now. 1998-12-01 18:58:28 +00:00
Fred Drake eabfab1048 Nits to support conversions. 1998-12-01 18:37:59 +00:00
Fred Drake 1e270f0e03 Nits to support conversions. 1998-11-30 22:58:12 +00:00
Fred Drake 50b804dc88 Fix minor nit with respect to conversion.
Update some logical markup.
1998-11-30 22:14:58 +00:00
Fred Drake caa3379c4f Remove {\rm ...} constructs. 1998-11-30 21:53:47 +00:00
Fred Drake 84538cd076 Remove some remaining {\rm ...} constructs.
Update logical markup in a few spots.
1998-11-30 21:51:25 +00:00
Fred Drake 1776556f8f Markup nit to ease conversions. 1998-11-30 19:00:16 +00:00
Fred Drake 3d29955a6e Markup improvements to help with conversions. 1998-11-30 18:59:44 +00:00
Fred Drake 01d5d94020 Remove cruft from the old Texinfo conversion. This simplifies some of
the newer processing.
1998-11-30 17:33:38 +00:00
Fred Drake 5208823158 Remove bogus \@. 1998-11-30 16:27:37 +00:00
Fred Drake d61975e179 Minor markup nit to ease conversion processing. 1998-11-30 16:26:50 +00:00
Fred Drake f6c59e8fff Do all the right imports. Problem reported by Martijn Faassen
<faassen@vet.uu.nl>.
1998-11-30 15:07:26 +00:00
Fred Drake 4471f20ed4 Logical markup.
Fix a few things for the conversion to structured markup.

Removed texinfo special cases, since there's likely a new info
process.
1998-11-25 22:38:24 +00:00
Fred Drake f65e323101 Fix remaining {\rm ...} construct. 1998-11-25 20:55:03 +00:00
Guido van Rossum 5eabf3823b Clarify that min and max also take multiple arguments. 1998-11-25 18:53:05 +00:00
Fred Drake e839199014 Fix indexing of func_code attribute; this is on a function, not a code
object.

Add "()" to method names indexed using \ttindex{}.
1998-11-25 17:09:19 +00:00
Guido van Rossum 04307ce789 Rewrote the section on sys.exit(), documenting other argument types
than integers and recommending sys.exit("message").
(I see this as Python's answer to Perls ``die "message";''.)
1998-11-23 17:49:53 +00:00
Guido van Rossum da30f4ca6b Fix typo in doc for handle(): client_request should be client_address.
Noted by Stefan Witzel.
1998-11-16 19:07:04 +00:00
Fred Drake c46973c89b Document the user and password parameters to the NNTP constructor. 1998-11-16 17:11:30 +00:00
Fred Drake 2510d22048 Clarify the default buffering for open(). (Comment from Andrew Dalke
<dalke@bioreason.com>).
1998-11-02 18:57:34 +00:00
Fred Drake cab91efd34 Fix Barry's markup. 1998-11-02 17:23:25 +00:00
Fred Drake 9ed1a0afb9 Moved zmod and poly descriptions to the Obsolete section. 1998-11-02 15:46:21 +00:00
Barry Warsaw 4a1cdd7f22 Document the new features of this module 1998-10-31 23:19:00 +00:00
Fred Drake 130072d663 Don't describe something as "below"; that won't make sense for the
HTML version.  Give a reference to the actual section to allow a
hyperlink to be built.
1998-10-28 20:08:35 +00:00
Fred Drake c024c99faf Fix typo reported by Gerry Weiner <gerry@ucar.edu>. 1998-10-28 18:19:16 +00:00
Andrew M. Kuchling c1cea208bc Added URL to HOWTO page, with reference to Regex HOWTO.
Corrected error: {,5} is not equivalent to {0,5}.
1998-10-28 15:44:14 +00:00
Guido van Rossum 04101960e6 Indicate that os.environ may not be a real dictionary. 1998-10-24 20:16:56 +00:00
Guido van Rossum 18fa7d2800 Typo: JIFF -> JFIF. 1998-10-19 13:30:01 +00:00
Guido van Rossum f35b884c91 Clarify that close() of a stream opened by popen() returns None if the
exit status is zero.
1998-10-15 13:28:29 +00:00
Guido van Rossum 7d447aabbf Moved search and match around so that search is documented first. 1998-10-13 16:03:52 +00:00
Barry Warsaw afd974c2ab Document the new list.extend() method. Interesting enough, the
canonical definition of extend() is very similar to append() except
that the former doesn't list-ify the argument!
1998-10-09 16:39:58 +00:00
Fred Drake 09b295754f Remove extra } at end of method description parameters. 1998-10-01 20:43:13 +00:00
Barry Warsaw b2031f72d3 Document that apply() can now take any sequence in argument 2. 1998-10-01 15:35:43 +00:00
Guido van Rossum 9814a943a5 Add warning that on Windows it only works on sockets. 1998-09-28 14:28:38 +00:00
Guido van Rossum 954b9adcd2 Document new urllib features by Eric Raymond. 1998-09-28 14:08:29 +00:00
Guido van Rossum 5fb2631ff9 Explicitly document the fact that the search method returns a MatchObject.
(Reported by Gary Herron.)
1998-09-21 19:26:16 +00:00
Guido van Rossum 6ac06b39b3 Patch by Greg Stein to document the 'P' flag. 1998-09-21 14:44:34 +00:00
Fred Drake 10a7985565 re.findall(): Mark as added in 1.5.2. 1998-09-18 17:11:49 +00:00
Guido van Rossum 43b655c0ab Get rid of 'ppp' that accidentally crept in. 1998-09-17 17:07:15 +00:00
Guido van Rossum 6442116029 Richard Wolff's changes, documenting his changes to pdb.py. 1998-09-17 15:11:51 +00:00
Fred Drake d16d4981d1 Markup nits. 1998-09-10 20:21:00 +00:00
Fred Drake 9b134bf716 Added comment about support for rational numbers, and pointer to
Demos/classes/Rat.py.
1998-09-10 18:42:55 +00:00
Fred Drake 7a2f0668e4 Markup nits.
Fixes/index improvements from Michael Ernst <mernst@cs.washington.edu>.
1998-09-10 18:25:58 +00:00
Guido van Rossum dbf7956e52 Clarify Y2K behavior when a tuple with a 2-digit date is passed to
mktime() and such.
1998-08-25 14:44:49 +00:00
Fred Drake 607f802886 round(): Mark the second (optional) parameter as optional, since it's
described that way.

setattr():  Clarify that the attribute doesn't need to exist to be set.
1998-08-24 20:30:07 +00:00
Fred Drake c859350fa6 Added some cross-references to the end. 1998-08-24 18:46:14 +00:00
Fred Drake d0421dd448 spoking --> speaking
object whose method this is --> object on which the method operates
1998-08-24 17:57:20 +00:00
Fred Drake 637af13dca There is no <ISINPUT> element, just <ISINDEX>. ;-) 1998-08-21 20:02:06 +00:00
Andrew M. Kuchling 42db27fedc Added an example that uses signal.alarm() to time out an os.open() that
takes too long. This example relies on the fact that raising an
    exception in a signal handler causes the exception to be re-raised
    when the main line of the program resumes execution.  Is this guaranteed
    in CPython, or is this something that just happens to work by accident?

Also fixed a typo.
1998-08-18 19:38:54 +00:00
Fred Drake e7210dad6c Fix arguments for renames(); bug spotted by Oliver Andrich
<oli@rhein-zeitung.de>.
1998-08-17 13:29:06 +00:00
Fred Drake a5aefbad5a Fix markup where C include files get named in <...> form; bug reported by
Lorenzo M. Catucci <lorenzo@argon.roma2.infn.it>.
1998-08-14 17:05:17 +00:00
Andrew M. Kuchling d22e25002a Clarify wording in the description of re.split
Simplify the patterns in the examples for re.split
1998-08-14 14:49:20 +00:00
Guido van Rossum 3a5a02f3da Second definition of popen2 should be popen3. 1998-08-13 01:27:01 +00:00
Fred Drake 211f22c1b1 Added the test package under "Frameworks". 1998-08-11 18:13:31 +00:00
Fred Drake 2f343eb5cf Moved to ../templates/module.tex. 1998-08-11 17:30:02 +00:00
Fred Drake 5bdf88a364 Removed now-documented modules from the list. 1998-08-11 15:49:09 +00:00
Fred Drake 23f414c539 Added new sections. 1998-08-11 15:47:16 +00:00
Fred Drake e72e1e02fe Documentation for the compileall module. 1998-08-11 15:46:42 +00:00
Fred Drake 4756bb3e54 Documentation for the py_compile module. 1998-08-11 15:46:25 +00:00
Fred Drake 64c105d3d2 Added index entries.
Small markup nits.
1998-08-11 15:18:45 +00:00
Fred Drake 295da24eaf New section header style.
Fix up a few synopses.
1998-08-10 19:42:37 +00:00
Fred Drake 23329d41bc Some logical markup, some nits. 1998-08-10 17:46:22 +00:00
Fred Drake 66da9d69fc re is standard, not built-in. 1998-08-07 18:57:18 +00:00
Guido van Rossum cdf6af1233 Document gethostbyname_ex(). 1998-08-07 18:07:36 +00:00
Guido van Rossum 730d83797e Clarify that quit() and close() render the instance useless. 1998-08-07 17:36:59 +00:00
Fred Drake 161edc29a6 Added file transfer to example. 1998-08-07 17:30:49 +00:00
Fred Drake 60c3cafc24 In the example, make sure all the imports are done. 1998-08-07 16:03:32 +00:00
Fred Drake 3700b6f94e Markup nits. 1998-08-07 16:02:28 +00:00
Fred Drake c18a6f3bfe Clarify xdrlib synopsis. 1998-08-07 16:01:15 +00:00
Fred Drake 2d62395a8e Fix typo in binascii synopsis. 1998-08-07 16:00:30 +00:00
Fred Drake 150ee43c64 Removed obsolete chapter header. 1998-08-07 15:58:54 +00:00
Fred Drake f44c4851e9 New organization of internet modules into protocols/support and data
chapters.
1998-08-07 15:58:31 +00:00
Fred Drake 29fe944787 New chapter headers for Internet Protocols and Internet Data chapters,
which replace the existing internet chapter.
1998-08-07 15:56:52 +00:00
Fred Drake d795c5cbd1 Fix synopsis for multifile. 1998-08-07 15:55:14 +00:00
Fred Drake 399fea89cb Shorten the module synopsis. 1998-08-06 21:30:32 +00:00
Fred Drake 72d157e998 Shorten the module synopsis. 1998-08-06 21:23:17 +00:00
Fred Drake 23a163454a Markup nit. 1998-08-06 15:33:55 +00:00
Fred Drake 1a3c2a0ede Markup nits. 1998-08-06 15:18:23 +00:00
Fred Drake 56fa8a7e4b Marked makedirs(), removedirs(), renames() as added in 1.5.2. 1998-08-06 13:45:42 +00:00
Guido van Rossum 5fdd119aba Clarify the + and b mode characters for open() a bit. 1998-07-29 21:05:35 +00:00
Fred Drake 9f86b662d1 Update to use a separate page for front matter. 1998-07-28 21:55:19 +00:00
Fred Drake ee7fd697bf Fixed the gzip synopsis. 1998-07-27 22:30:15 +00:00
Fred Drake a30e469fda Added the popen2 synopsis. 1998-07-27 22:20:02 +00:00
Fred Drake 54327c4c05 Added the calendar synopsis. 1998-07-27 22:18:24 +00:00
Fred Drake edf6b1f431 Added the bisect synopsis. 1998-07-27 22:16:46 +00:00
Fred Drake 9030b0f053 Added the dumbdbm synopsis. 1998-07-27 22:12:26 +00:00
Fred Drake 08caa964c4 Added a synopsis. 1998-07-27 22:08:49 +00:00
Fred Drake 9643c6706f Fix the synopsis.
Change one \code{} to \samp{}.
1998-07-27 22:06:12 +00:00
Fred Drake b44e75339a Mark the new & changed items. 1998-07-27 21:11:42 +00:00
Guido van Rossum 2babd7b151 Document getsize(), getmtime(), getatime(). 1998-07-24 20:49:39 +00:00
Guido van Rossum 89a79d19b7 Document makedirs(), removedirs(), renames() -- ESR-inspired super-versions
of mkdir(), rmdir() and rename() that make or remove intermediate
directories as well.
1998-07-24 20:48:20 +00:00
Guido van Rossum b193c95165 Document Ellipsis (not much of a documentation snippet, but at least
it's mentioned.
1998-07-24 15:02:02 +00:00
Guido van Rossum 1eb200d360 Added 3 missing types: ComplexType, SliceType, EllipsisType. 1998-07-24 15:01:05 +00:00
Fred Drake 78a6ddbdd1 Move files around in a different way, so CVS picks up all the changes. ;-) 1998-07-24 14:27:22 +00:00
Fred Drake 64e3b43583 Move files around to get the names to match the module names except for
case.  Two modules (SocketServer, BaseHTTPServer) still don't match; those
names are just too long!
1998-07-24 13:56:11 +00:00
Fred Drake cf0fb8bfee Document the 'p' format character.
Clean up some of the markup.
1998-07-23 21:18:25 +00:00
Fred Drake c457ca7ede Fix up Barry's markup, which didn't pass the latex test. ;-) 1998-07-23 20:31:53 +00:00
Barry Warsaw da00c878bd Added descriptions of EnvironmentError and OSError; updated IOError to
reflect its new place in the exception hierarchy; fixed typos, etc.
1998-07-23 19:57:35 +00:00
Barry Warsaw eef2cd14c9 Updated the description of os.error to reflect the fact that it is now
equivalent to exceptions.OSError.
1998-07-23 19:50:09 +00:00