Commit Graph

1893 Commits

Author SHA1 Message Date
Fred Drake 9cfe1824c2 Add documentation for the StopIteration exception. 2001-05-03 04:30:45 +00:00
Fred Drake 287c4cb43a State that Mailbox objects are iterator objects. 2001-05-02 20:22:12 +00:00
Fred Drake eacdec6b38 Update the filter() and list() descriptions to include information about
the support for containers and iteration.
2001-05-02 20:19:19 +00:00
Fred Drake 93656e76f9 Added section describing the iterator protocol. 2001-05-02 20:18:03 +00:00
Guido van Rossum 8b3d6ca3df At the suggestion of Peter Funk, document 'key in dict' and 'key not
in dict' after has_key(), with a \versionadded{2.2} note.
2001-04-23 13:22:59 +00:00
Fred Drake 82f93c693d Only document <file>.xreadlines() once; added version annotation.
This closes SF bug #417943.
2001-04-22 01:56:51 +00:00
Fred Drake 4cacec5393 Fix a number of minor markup errors. 2001-04-21 05:56:06 +00:00
Guido van Rossum 0dbb4fba4c Implement, test and document "key in dict" and "key not in dict".
I know some people don't like this -- if it's really controversial,
I'll take it out again.  (If it's only Alex Martelli who doesn't like
it, that doesn't count as "real controversial" though. :-)

That's why this is a separate checkin from the iterators stuff I'm
about to check in next.
2001-04-20 16:50:40 +00:00
Fred Drake 1aec3a16f3 Add versioning notes: many of the signatures changed to allow the time
used to be omitted (meaning use the current time) as of Python 2.1.
Users who need cross-version portability need to know things like this.
2001-04-19 04:55:23 +00:00
Fred Drake bc524c4e9f Cut-&-paste-o noted by Wolfgang Teschner: decompressobj() returns
*DE*compression objects, not compression objects!
2001-04-18 20:16:51 +00:00
Fred Drake 895aa9da4c Suggestion from Keith Briggs: refer to RE objects consistently instead of
introducing a new term ("regex") without defining it.
2001-04-18 17:26:20 +00:00
Fred Drake 293f77af6f Add note about the version in which GetoptError was added -- this can
bite people interested in 1.5.2 compatibility.
2001-04-18 03:18:57 +00:00
Fred Drake c054c75582 Work around the conversion of ">>" and "<<" to guillemets. Reported by Ping. 2001-04-13 17:25:38 +00:00
Fred Drake a3e56a6ceb Minor markup adjustments.
Turn reference to the cmd module into a hyperlink.
2001-04-13 14:34:58 +00:00
Eric S. Raymond 4f3980d3cb Added a test main to the pstats library that can help you browse profile dumps. 2001-04-13 00:23:01 +00:00
Fred Drake 47f11ce591 Added warning that FancyURLopener prompts the user on the terminal when
basic authentication is needed.

Added documentation for FancyURLopener.prompt_user_passwd(), explaining
that subclasses should provide more appropriate behavior for the hosting
environment.
2001-04-12 20:26:49 +00:00
Fred Drake 62a26699c4 Added module synopsis for the chapter summary.
Added documentation for TestCase.assertRaises().

Added text for "Mapping concepts to classes", and merged it into the
front matter instead of separating it into a new section.

Removed use of "assert" in examples.

Update the descriptions to reflect further changes from discussions on
the pyunit-interest list.

Added documentation for the defaultTestLoader object and the
TestLoader methods.

Added the assert*() names for the TestCase helper methods.
2001-04-12 19:34:38 +00:00
Fred Drake e20bd19f86 Convert several \seetext references to \seerfc and \seetitle versions.
These format somewhat better and include more semantic information in the
source.
2001-04-12 16:47:17 +00:00
Fred Drake 0056a427bb Added a lot of text from Steve Purcell's HTML documentation.
Updated reference material substantially based on discussions on the
pyunit-interest mailing list (not all changes are in the code in CVS
yet).
2001-04-12 04:50:06 +00:00
Fred Drake b942c2f788 Fixed bug in example.
This closes SF bug #415522.

Also fix markup error in text following the example.
2001-04-11 21:33:47 +00:00
Barry Warsaw c3cbbaf513 Added some additional documentation describing how BabylMailbox
actually works (it returns a message containing the visible headers,
not the original headers).  Doc change approved by Fred; closes SF bug
#412230.
2001-04-11 20:12:33 +00:00
Fred Drake eedf985056 Include a synopsis for the chapter overview. 2001-04-11 19:17:11 +00:00
Moshe Zadka 2bd0d88360 Fixing bug 405999 -- clarifying differences between Python's
getopt and GNU getopt -- Python is like classical UNIX getopt.
2001-04-11 07:33:08 +00:00
Fred Drake 29be70195a Added definition of "test fixture".
Added description of optional parameter to the TestSuite constructor.

Added descriptions of the TestLoader and TextTestRunner classes.

Added method descriptions for the TestCase class.
2001-04-10 22:25:06 +00:00
Fred Drake ac154a17a3 Remove the mapping() function from the documentation.
Add a description of the ReferenceError exception.
2001-04-10 19:57:58 +00:00
Fred Drake da00cda9fa Add note that difflib was added in Python 2.1. 2001-04-10 19:56:09 +00:00
Fred Drake cfac6d23fd Normalize tabs to spaces.
Update the attribution for the "Curses Programming with Python" How-To.

Change the way the reference to the Demo/curses/ directory is marked up.
2001-04-10 18:49:09 +00:00
Fred Drake 6fda3ac474 Add reference to the DDJ article discussing a similar algorithm. 2001-04-10 18:41:16 +00:00
Fred Drake 90a72f8dcd Add documentation for getmoduleinfo() and getmodulename(). 2001-04-10 15:12:34 +00:00
Fred Drake 819815abea Fix typo in example (\b should be \n in string literal).
This closes SF bug #414279.
2001-04-09 15:57:06 +00:00
Fred Drake 9c846366ee Fix a number of bugs and omissions in the AddressList documentation, most
noted by Steve Holden.


This closes SF bug #413876.
2001-04-09 15:42:56 +00:00
Fred Drake 501d90471d Add entry for unittest documentation. 2001-04-07 05:42:14 +00:00
Fred Drake b9ad228798 Start of documentation for the unittest module. Some of this comes from
Steve Purcell's documentation, and a lot of it is written based on
using PyUnit and reading the implementation.

There is more to come, but I want to get this check in before I have a
disk crash or anything else bad happens.
2001-04-07 05:41:39 +00:00
Fred Drake 4cf1227e56 Change {\em ...} to \emph{...} for consistency with the rest of the Python
documentation.
2001-04-05 18:31:27 +00:00
Fred Drake f459d852e5 Add some information about what to expect of the DocumentType's
.internalSubset attribute based on a clarification from the www-dom
list.
2001-04-05 18:30:04 +00:00
Fred Drake 659f377ed9 Add entry for curses.panel documentation. 2001-03-29 22:23:19 +00:00
Fred Drake 14631f674f Fix serious markup errors. 2001-03-29 22:22:23 +00:00
Fred Drake cb83988151 Added example use of weak references, contributed by Tim Peters. 2001-03-28 21:15:41 +00:00
Fred Drake 21e036ccca Add a note that the "kfm" controller supports "konqueror" as well as the
old KDE 1 "kfm" command.
2001-03-26 16:17:21 +00:00
Guido van Rossum c8da0f966f Document use_rawinput. (Although now that I think more about it, a
better solution would have been to factor out the raw_input() call and
make it into an overridable method.  Oh well, maybe later...)
2001-03-24 19:17:35 +00:00
Jeremy Hylton aa90adcfb9 Add nested scopes spec to appendix.
Add new opcodes LOAD_CLOSURE, LOAD_DEREF, STORE_DEREF, MAKE_CLOSURE to
docs for dis module.

Add docs for new function and code members in Sec. 3 of ref manual.
They're present regardless of whether nested scopes are used.

Remove description of default argument hack from Sec. 7 of the ref
manual and refer the reader to the appendix.
2001-03-23 17:23:50 +00:00
Ka-Ping Yee ce7298ab42 Explain the difference between NL and NEWLINE. 2001-03-23 05:22:12 +00:00
Ka-Ping Yee c608fb6389 Give a slightly better explanation of excepthook. 2001-03-23 05:17:41 +00:00
Fred Drake 5e0dfaccd1 Update to the most recent weakref changes. 2001-03-23 04:36:02 +00:00
Ka-Ping Yee b5c5132d1a Add sys.excepthook.
Update docstring and library reference section on 'sys' module.
New API PyErr_Display, just for displaying errors, called by excepthook.
Uncaught exceptions now call sys.excepthook; if that fails, we fall back
    to calling PyErr_Display directly.
Also comes with sys.__excepthook__ and sys.__displayhook__.
2001-03-23 02:46:52 +00:00
Fred Drake 4e6d09e369 Moved the description of the tzparse module to the "Obsolete" section
and note that it fails when the TZ environment variable is not set.

This closes SF bug #409683.
2001-03-20 23:13:53 +00:00
Fred Drake b15bbc8d3d Add documentation for SGMLParser.handle_decl(). 2001-03-16 20:39:41 +00:00
Fred Drake f0ebbe0bd0 Re-order some method descriptions for a more logical grouping.
(Based on reader comment!)
2001-03-08 22:46:41 +00:00
Fred Drake 990b0fec1a Update documentation to reflect the shift to NetrcParseError instead of
SyntaxError.
2001-03-06 06:55:18 +00:00
Fred Drake 93c867139f Lots of organizational changes for consistency with the rest of the
documentation.

Fix a few small markup nits.
2001-03-02 20:39:34 +00:00
Fred Drake 043d5e5514 For copyfile(), be explicit that src and dst are file names; that was only
implied.
2001-03-02 16:46:42 +00:00
Fred Drake 7606e4d00e Added entry for urllib2 documentation. 2001-03-01 19:54:29 +00:00
Guido van Rossum f89ad5ed6b Document configuration flags to compile for large file support on
certain Linux systems.
2001-03-01 18:29:57 +00:00
Moshe Zadka 8a18e99008 Checking in patch 404826 -- urllib2 enhancements and documentations.
(please not that the library reference does *not* include the
urllib2 documnetation -- that will wiat for Fred)
2001-03-01 08:40:42 +00:00
Guido van Rossum 56ba72a563 Document warn_explicit(). 2001-02-28 23:34:21 +00:00
Fred Drake 7840a9cb99 Add entry for the inspect module. 2001-02-28 23:02:20 +00:00
Fred Drake 6dbd382ec8 Clean up some of the markup for consistency, wrap some long lines. 2001-02-28 23:01:38 +00:00
Skip Montanaro 58177b9975 added description of NL token 2001-02-28 22:05:41 +00:00
Fred Drake 969ab2710a Update documentation for termios module; do not refer to the TERMIOS module
for constant definitions.

Add a deprecation to the TERMIOS module.
2001-02-27 22:01:15 +00:00
Martin v. Löwis 5e1633365d Patch #403985: Add support for weak-keyed dictionaries 2001-02-27 18:36:56 +00:00
Ka-Ping Yee 6397c7c9a9 inspect: a module for getting information out of live Python objects 2001-02-27 14:43:21 +00:00
Barry Warsaw d4614e8371 Updates to the semantics of function and method attributes. 2001-02-27 03:32:35 +00:00
Fred Drake 07e6c505ad Minor adjustments, including markup corrections. 2001-02-23 19:15:56 +00:00
Fred Drake 447f545322 Fix extra backslash in example. 2001-02-23 19:13:07 +00:00
Fred Drake afdc8fc0ad Fix up the markup in some recently-added portions of the text. 2001-02-23 19:10:41 +00:00
Fred Drake 19f3c52347 Work around the broken formatting of sys.ps1 prompts in running text.
Move sample sessions to the left margin of the file for consistency;
formatting can adjust the margin if needed.

This closes SF bug #133213.
2001-02-22 23:15:05 +00:00
Fred Drake 7c30de65f4 Remove documentation for the soundex module; the module is no longer
included with Python.
2001-02-22 21:25:20 +00:00
Martin v. Löwis 7edbd4ffb4 Patch #103885: Add dynamic registration and lookup of DOM implementations. 2001-02-22 14:05:50 +00:00
Tim Peters 754ba589b7 Improve accuracy. In the .tex file, note the new "% BUG:" comments: an
extra backslash is getting displayed in the generated HTML.
2001-02-20 11:24:35 +00:00
Tim Peters f0768c822b Added missing \item. See also bug 133213, about damaged HTML generated
for \code(">>>"); don't know how to fix that one.
2001-02-20 10:57:30 +00:00
Tim Peters e79af273e8 Flesh out PlaySound() docs enough so that SND_ALIAS isn't hopelessly confusing.
If someone knows how to turn the new table of guaranteed-registered system
sounds into a LaTeX table, be my guest.
2001-02-20 10:02:21 +00:00
Fred Drake 5b0705d266 ConfigParser.optionxform(): Document this since it is available for
sub-classes and application code to override.
2001-02-19 22:37:24 +00:00
Fred Drake 15bc404ca8 Added entries for difflib documentation. 2001-02-19 16:32:40 +00:00
Fred Drake baf71422b8 Documentation for the difflib module, converted from the module docstrings. 2001-02-19 16:31:02 +00:00
Tim Peters 373d151666 More typos. libwinsound.tex typo noted by Peter Funk (thanks!). 2001-02-19 08:36:41 +00:00
Tim Peters 25a9ce371c Take a tour of hell's seedier neighborhoods to try to make winsound.Beep()
do something non-useless on Win9X boxes.  WinME unknown to me.  Someone with
NT/2000 make sure it still works there!
2001-02-19 07:06:36 +00:00
Tim Peters c4089d84d8 In the example showing the irrelevance of start columns, restore that the
start columns differ (editing had pushed them all into column 0).
2001-02-17 18:03:25 +00:00
Fred Drake f3262b72ca Add entries for the doctest documentation. 2001-02-17 17:33:25 +00:00
Fred Drake 7eb1463bb3 Make a variety of minor markup adjustments.
Close some environments so that this will actually format.
2001-02-17 17:32:41 +00:00
Tim Peters 7688229f7c SF patch #103808: doctest.py docs
Checking in Moshe's patch after rewrapping some paragraphs (to consume
fewer columns) and repairing that I/2.**J lost the I.
2001-02-17 05:58:44 +00:00
Skip Montanaro 04f1d37471 mention the use of the maxtries attribute of FancyURLopener in bounding
redirection recursion.
2001-02-15 17:00:40 +00:00
Guido van Rossum bf416fa0dd Document default blocksize for storbinary(). 2001-02-15 13:53:40 +00:00
Fred Drake 523ec5709b Make some clarifications and corrections based on comments from Guido.
Fix a few markup nits.
Work around a LaTeX2HTML nuisance.
2001-02-15 05:37:51 +00:00
Fred Drake 15862f50e5 Add a note to Node.isSameNode() that it is based on the DOM Level 3 working
draft.  I'm not sure that's important, but Uche thinks it is.
2001-02-14 20:39:15 +00:00
Fred Drake 1d8ad2b1de Updated to reflect the additional information and interfaces exported in
pyexpat.c revision 2.40.
2001-02-14 18:54:32 +00:00
Fred Drake 162c6a637a Reflect change in traceback format:
"innermost last" --> "most recent call last"
2001-02-14 03:20:18 +00:00
Andrew M. Kuchling e7d7e6c879 Fix two typos 2001-02-14 02:39:11 +00:00
Fred Drake 5ed1dac4c0 Update documentation for pyexpat (xml.parsers.expat), to reflect the new
support for Expat 1.95.*.
2001-02-08 15:40:33 +00:00
Fred Drake cf2636696d Fix markup typo in a {verbatim} environment (there should not be any!);
caught by Eric Raymond.
2001-02-03 14:35:38 +00:00
Fred Drake 40e43bfaf7 Document Node.isSameNode(). 2001-02-03 01:20:01 +00:00
Fred Drake f891404e1a Move the whrandom section back to the documented modules section; this
gives people a chance to see the depracation notice.
2001-02-03 01:17:41 +00:00
Fred Drake 269625f67a Revise the deprecation note for the whrandom module to be correct and a
little more formal.
2001-02-03 01:12:44 +00:00
Fred Drake 6270031f4e Adjustments to the text of the UnixMailbox description. Added
PortableUnixMailbox as a separate class as well (this also generates
the right index entry).
2001-02-02 03:51:05 +00:00
Fred Drake 57d943ad38 Move the whrandom entry to the "Obsolete Modules" appendix. 2001-02-02 02:45:08 +00:00
Fred Drake 844bd5b4a9 Minor markup adjustments. 2001-02-02 02:42:31 +00:00
Fred Drake 68b6417c5a Added a warning at the top saying that user code should not use the
whrandom module directly.
2001-02-02 02:41:17 +00:00
Fred Drake d0946da701 Fix some markup breakage that prevented formatting; re-wrapped a couple of
wide paragraphs.
2001-02-01 15:53:24 +00:00
Fred Drake 36154b2dbf Added entry for weakref documentation.
Moved commented-out entries for obsolete module to an appendix, still
commented out.
2001-02-01 05:21:46 +00:00
Fred Drake ebcf6a8573 Documentation for the weakref module. 2001-02-01 05:20:20 +00:00
Tim Peters 0de88fc4b1 Change random.seed() so that it can get at the full range of possible
internal states.  Put the old .seed() (which could only get at about
the square root of the # of possibilities) under the new name .whseed(),
for bit-level compatibility with older versions.  This occurred to me
while reviewing effbot's book (he found himself stumbling over .seed()
more than once there ...).
2001-02-01 04:59:18 +00:00