905dc558f1
Cleaned up the description of readline.set_completer().
...
Thanks to Nathaniel Gray for reporting the confusion.
2001-08-01 21:42:45 +00:00
e74f8de385
Added an example of a string value for the replacement parameter to
...
re.sub().
This closes SF bug #446136 .
Fixed description of RE modifiers so that RE{#} and RE{#,} are more
clearly described and disambiguated (plain RE{#} had not been described
at all). Reported by Jeremy Craven via email.
2001-08-01 16:56:51 +00:00
630a63cafd
Fix description of buffer_info(), and add a note that there is a better
...
way...
This closes SF bug #444842 .
2001-08-01 16:50:49 +00:00
43211ecda2
Make some adjustments to the markup, and fix up some style-guide issues.
2001-07-29 03:41:23 +00:00
66b6e192b9
Patch #416224 : add readline completion to cmd.Cmd.
2001-07-28 14:44:03 +00:00
54f65094c3
Typo fix.
2001-07-26 21:01:21 +00:00
7321ec437b
SF bug #444510 : int() should guarantee truncation.
...
It's guaranteed now, assuming the platform modf() works correctly.
2001-07-26 20:02:17 +00:00
4f1cd8bdcb
Patch #411138 : Rename config.h to pyconfig.h. Closes bug #231774 .
2001-07-26 13:41:06 +00:00
41d7d58cc4
trivial rewording in footnote 5.
2001-07-25 16:18:19 +00:00
d61e3eab44
Add entry for the new distutils section.
2001-07-24 16:20:13 +00:00
4fefcc3ce4
Overview comments for the distutils package, with links to the distutils
...
manuals for more information. This is being added to make it easier to
find the documentation for the distutils code.
2001-07-24 16:19:24 +00:00
c547b46c06
Be more specific about corner cases in the description of the $ RE syntax,
...
and include an example where the MULTILINE flag makes a real difference.
This closes SF bug #441600 .
2001-07-23 21:14:59 +00:00
6fd3b22847
When explaining the enterabs() method, using the modern spelling of apply(),
...
and relax the type of the argument list from tuple to sequence.
2001-07-23 19:28:09 +00:00
6fdb90c0ca
Remove self-reference from the anydbm module.
...
This closes SF patch #443788 .
2001-07-23 19:22:42 +00:00
8a2adcf812
Typo: Added missing "if".
...
This is part of SF patch #442788 .
2001-07-23 19:20:56 +00:00
c046e97dc2
Add StopIteration to the list of exceptions *not* derived from StandardError.
...
Slightly re-word discussion of SystemExit and fork().
This is part of SF patch #443788 .
2001-07-23 19:19:39 +00:00
63bc2e0fcb
Convert the use of apply(f, args) to the new spelling: f(*args).
...
This is part of SF patch #443788 .
2001-07-23 19:16:22 +00:00
f69868f304
Add a missing "\" to the markup.
2001-07-20 19:03:44 +00:00
960fdf9ac3
Added the constants ascii_letters, ascii_lowercase, and ascii_uppercase
...
to the string module. This was determined to be the right approach in
SF bug #226706 .
2001-07-20 18:38:26 +00:00
a3a1668904
apply patch item #416254
2001-07-20 11:04:19 +00:00
acd32d3be5
Added function xml.sax.saxutils.quoteattr().
...
This closes SF bug #440351 . It should not be moved to Python 2.1.1.
2001-07-19 16:10:15 +00:00
53d285a9af
Remove some false statements.
2001-07-19 03:49:33 +00:00
28bafb8b5d
Fix a few typos
2001-07-19 01:17:15 +00:00
72182027a8
"Make small changes, but carry a big diff."
...
Minor local consistency adjustments.
A couple of small tweaks to the setdlopenflags() description.
For setprofile() and settrace(), convert some references to become
hyperlinks in the HTML version.
2001-07-18 17:52:58 +00:00
1a2302b3b2
Add some symbolic names to support hyperlinked references.
2001-07-18 17:40:19 +00:00
5d808fba00
Made a few minor style & markup changes to the new {get,set}dlopenflags()
...
descriptions; added availability notes.
2001-07-18 16:35:05 +00:00
f0473d511b
Patch #412229 : Add functions sys.getdlopenflags and sys.setdlopenflags.
...
Add dlopenflags to PyInterpreterState, and use it in dlopen calls.
2001-07-18 16:17:16 +00:00
efaef13c81
Update the availability information for os.tempnam(), os.tmpfile(), and
...
os.tmpnam().
2001-07-17 20:39:18 +00:00
e78661bf90
Fix a couple of minor markup nits.
...
Footnotes should be added *after* punctuation, not before.
(Yes, this should be merged with the descr branch. Sorry, Tim!)
2001-07-17 05:17:58 +00:00
95400a28e4
Updated the documentation in several respects:
...
- This module, despite its name, now should conform to RFC 2822, the
update to RFC 822.
- This module doesn't just represent "email headers", but entire email
messages.
- Added documentation for other useful public functions such as
quote(), unquote(), praseaddr(), and dump_address_pair().
2001-07-16 20:47:58 +00:00
687a17deaa
Revise the description of time.clock() so that it correctly describes the
...
Windows version of the function as well as the Unix flavor.
This fixes SF bug #441357 .
2001-07-16 15:40:57 +00:00
8ee679f0ce
Minor changes to match the style guide.
2001-07-14 02:50:55 +00:00
4124a0b343
Correct a couple of errors noted by Alex Martelli.
2001-07-14 02:46:01 +00:00
7fc8abb396
Remove comments about XML and HTML; those sections are no
...
longer part of this chapter.
Minor change to match the style guide.
2001-07-14 02:44:43 +00:00
3d97e35a20
Add entry for xmlrpclib documentation.
2001-07-12 23:40:13 +00:00
5ddf7adf84
Several markup adjustments so this will format and be more consistent with
...
the rest of the documnentation.
2001-07-12 23:39:24 +00:00
f4bdb57e15
Fix return value for m.group() for groups not in the part of the RE that
...
matched; reported by Paul Moore.
Wrapped several long lines.
2001-07-12 14:13:43 +00:00
bf5a774bcb
On int/long to the negative int/long power, let float handle it
...
instead of raising an error. This was one of the two issues that the
VPython folks were particularly problematic for their students. (The
other one was integer division...) This implements (my) SF patch
#440487 .
2001-07-12 11:27:16 +00:00
e304bb9eec
First version of xmlrpclib docs. Probably has markup errors; is not complete,
...
could probably stand to have some of the internal things like Marshaller
documented. But I think it does a decent job on the entry points and
externally visible things.
Fred and Fredrik, do your stuff! You both need to proof this.
2001-07-12 02:39:45 +00:00
682d5f3cda
Follow the recommended practices for keystroke representation; this
...
improves internal consistency in the documentation.
2001-07-12 02:09:51 +00:00
9bbc933fcb
Added information about the timeout parameter to the poll() method for
...
polling objects. This closes SF bug #439823 .
Fixed a minor markup bug.
2001-07-11 18:48:39 +00:00
907e76b620
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
...
translation more difficult, as well as reading the English more
difficult for non-native speakers.
2001-07-06 20:30:11 +00:00
ab1df4fe88
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
...
translation more difficult, as well as reading the English more
difficult for non-native speakers.
Add an index entry for the Telnet protocol.
Always refer to the protocol as Telnet instead of telnet.
2001-07-06 20:23:02 +00:00
91f2f26d75
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
...
translation more difficult, as well as reading the English more
difficult for non-native speakers.
2001-07-06 19:28:48 +00:00
45c23e61d8
Explain the exit code for the wait() method, including a reference to
...
the os.W*() functions used to interpret the return value.
This fixes SF bug #429361 .
2001-07-06 17:17:12 +00:00
bcd1df746d
The fpectl module does not work on Windows, so remove Windows from the
...
\platform statement.
Also fix a minor style consistency nit in an example.
2001-07-05 21:17:08 +00:00
a939911345
Fix a markup error: do not omit a method's parameter list if it is
...
empty.
2001-07-05 21:14:03 +00:00
25211f5724
Added more information on the differences between the htmllib and HTMLParser
...
modules.
2001-07-05 16:34:36 +00:00
5fe2c139d5
List constraints on xrange() objects.
2001-07-05 15:27:19 +00:00
3f56166b1a
Rip out the fancy behaviors of xrange that nobody uses: repeat, slice,
...
contains, tolist(), and the start/stop/step attributes. This includes
removing the 4th ('repeat') argument to PyRange_New().
2001-07-05 13:27:48 +00:00
20006b2d51
Marked the parameters to Stats.print_*() as optional.
...
This closes SF bug #438032 .
2001-07-02 21:22:39 +00:00
4efb6e9643
Turns out Neil didn't intend for *all* of his gen-branch work to get
...
committed.
tokenize.py: I like these changes, and have tested them extensively
without even realizing it, so I just updated the docstring and the docs.
tabnanny.py: Also liked this, but did a little code fiddling. I should
really rewrite this to *exploit* generators, but that's near the bottom
of my effort/benefit scale so doubt I'll get to it anytime soon (it
would be most useful as a non-trivial example of ideal use of generators;
but test_generators.py has already grown plenty of food-for-thought
examples).
inspect.py: I'm sure Ping intended for this to continue running even
under 1.5.2, so I reverted this to the last pre-gen-branch version. The
"bugfix" I checked in in-between was actually repairing a bug *introduced*
by the conversion to generators, so it's OK that the reverted version
doesn't reflect that checkin.
2001-06-29 23:51:08 +00:00
0c209047ba
Correct a markup error for an accented character.
...
Reported by Milan Zamazal <pdm@zamazal.org>.
2001-06-29 16:25:07 +00:00
58c95391fa
Removed some stray periods, and fix up a number of visible markup
...
consistency errors (mostly omitted "()" at the end of function and
method names).
Reported by Milan Zamazal <pdm@zamazal.org>.
2001-06-29 16:21:47 +00:00
f29ca18df3
SourceForge bug #437041 :
...
Use a portable format in the example that creates a timestamp suitable for
use in email, also updating it and the footnote from RFC 822 to RFC 2822.
2001-06-29 15:39:53 +00:00
9f9bd6af78
Simplify an example based on comment from Thomas Holenstein <thomas@hex.ch>:
...
Do not use an extra flag variable to test only once in one subsequent if
statement.
2001-06-29 14:59:01 +00:00
69940973db
Remove duplicate ', ' in dbhash.open()'s argument list.
2001-06-27 13:49:59 +00:00
e9218a1a8e
Remove the restriction on a mapping's .update() method.
2001-06-26 20:32:59 +00:00
3e7b1a04a0
Teach the types module about generators. Thanks to James Althoff on the
...
Iterators list for bringing it up!
2001-06-25 19:46:25 +00:00
b037d33245
Updated link to zlib's home page.
2001-06-25 15:30:13 +00:00
e7e03cd0cf
Fix typo
2001-06-23 16:26:44 +00:00
ff00fdae23
Correct erroneous description of precmd.
2001-06-23 14:42:43 +00:00
8058bfa6fc
Contributed updates from Harald Hanche-Olsen, giving details of the branch
...
cuts for the complex math functions. Includes a brief description of
what branch cuts are.
2001-06-23 03:16:29 +00:00
307cb05764
Re-organize a little, clean up some markup.
...
Added some comments about sys.exit(), SystemExit, and preventing restricted
code from exiting the interpreter.
This closes SF bug #434743 .
2001-06-22 18:21:53 +00:00
f66cb5d0eb
Corrected an error in the information on supporting weak references in
...
extension types (the docs reflected a development version of the API).
This closes SF bug #435066 .
2001-06-22 17:20:29 +00:00
93438bf0a2
Fix & clean up the information about building Python with large file support
...
for Linux.
This closes SF bug #434975 .
2001-06-22 16:01:20 +00:00
d5df09cfb6
Update to include the license information in a less annoying place.
2001-06-20 21:37:34 +00:00
6016e39250
Document the new encodestring() and decodestring() functions. Also,
...
add some description of what the quotetabs argument does for the
encode*() functions. Finally, add a "see also" pointing to the base64
module.
2001-06-19 19:44:42 +00:00
918f2c722a
Document that filter is added in 2.2.
2001-06-16 08:14:04 +00:00
54d10fd2cd
Add a version annotation for the Q and q format codes.
2001-06-15 14:13:07 +00:00
8fcd4b5ab3
Fix an improperly placed comma.
2001-06-14 13:57:16 +00:00
4a6c5c568f
Fixed reference to table notes for {}.keys() and {}.items() -- these
...
references did not get updated when the notes were renumbered in a
previous update.
This fixes SF bug #432208 .
2001-06-12 03:31:56 +00:00
7a3bfc3a47
Added q/Q standard (x-platform 8-byte ints) mode in struct module.
...
This completes the q/Q project.
longobject.c _PyLong_AsByteArray: The original code had a gross bug:
the most-significant Python digit doesn't necessarily have SHIFT
significant bits, and you really need to count how many copies of the sign
bit it has else spurious overflow errors result.
test_struct.py: This now does exhaustive std q/Q testing at, and on both
sides of, all relevant power-of-2 boundaries, both positive and negative.
NEWS: Added brief dict news while I was at it.
2001-06-12 01:22:22 +00:00
0b9bc20e66
Add the appropriate availability annotations for the popen*() family of
...
functions -- these are not available on traditional Mac OS platforms.
Corrected the version annotations for the spawn*() functions and related
constants; these were added in Python 1.6, not 1.5.2.
2001-06-11 18:25:34 +00:00
046f4d810d
Fixed parameter order for os.popen2(), os.popen3(), and os.popen(4). Added
...
a reference to these functions and popen() from the "Process Management"
section.
Based on a suggestion from comp.lang.python.
2001-06-11 15:21:48 +00:00
c115835457
Fix recent changes so that this section will format again.
2001-06-11 14:55:01 +00:00
7b9542a3f7
Initial support for 'q' and 'Q' struct format codes: for now, only in
...
native mode, and only when config #defines HAVE_LONG_LONG. Standard mode
will eventually treat them as 8-byte ints across all platforms, but that
likely requires a new set of routines in longobject.c first (while
sizeof(long) >= 4 is guaranteed by C, there's nothing in C we can rely
on x-platform to hold 8 bytes of int, so we'll have to roll our own;
I'm thinking of a simple pair of conversion functions, Python long
to/from sized vector of unsigned bytes; that may be useful for GMP
conversions too; std q/Q would call them with size fixed at 8).
test_struct.py: In addition to adding some native-mode 'q' and 'Q' tests,
got rid of unused code, and repaired a non-portable assumption about
native sizeof(short) (it isn't 2 on some Cray boxes).
libstruct.tex: In addition to adding a bit of 'q'/'Q' docs (more needed
later), removed an erroneous footnote about 'I' behavior.
2001-06-10 23:40:19 +00:00
1dc98c44fe
add warning about situation where code may be executed twice, once when
...
module is __main__ and once when module is imported.
2001-06-08 14:40:28 +00:00
62f9d7c021
In the section on extending the profiler, add some additional discussion
...
about setting up the dispatch table, and update the OldProfile and
HotProfile classes to the current implementations, showing the adjusted
construction for the dispatch table.
2001-06-08 05:04:19 +00:00
e2ccb89513
Document filter.
2001-06-07 19:01:24 +00:00
e24fef0dd2
Fix bug #422702 : Make flag argument to open optional, and document it that way.
2001-06-05 05:33:19 +00:00
b9d973dac5
is -> if in rename description
2001-06-04 15:31:17 +00:00
81e142b907
Document os.getenv().
...
This closes SF bug #429059 .
2001-05-31 20:27:46 +00:00
c19f39272e
Some general cleanup of the threading module documentation, including
...
fixing the reference to Thread.getDeamon() (should be isDaemon()).
This closes SF bug #429070 .
2001-05-31 20:24:07 +00:00
6cba3d0e64
Added entry for HTMLParser documentation.
2001-05-30 04:59:50 +00:00
3b755d43ac
Michel Pelletier <michel@digicool.com>:
...
Documentation for the HTMLParser module, with small changes by FLD.
2001-05-30 04:59:00 +00:00
dc9e7e42c8
readlink() description: Added note that the return value may be either
...
absolute or relative.
remove(), rename() descriptions: Give more information about the cross-
platform behavior of these functions, so single-platform developers
can be aware of the potential issues when writing portable code.
This closes SF patch #426598 .
2001-05-29 18:13:06 +00:00
c80d4dd695
The parameter to the listen() method is not optional, but was marked as
...
optional in the documentation.
This closes SF bug #427985 .
2001-05-29 15:37:45 +00:00
56a71eee65
Add a version annotation for splitdrive(); old, but as long as I managed
...
to end up with the information, it is better recorded than lost.
2001-05-25 16:21:00 +00:00
c6d8f8d2ac
Add descriptions of {}.iteritems(), {}.iterkeys(), and {}.itervalues()
...
in the table of mapping object operations. Re-numbered the list of
notes to reflect the move of the "Added in version 2.2." note to the list
of notes instead of being inserted into the last column of the table.
2001-05-25 04:24:37 +00:00
98cfab6523
One more update related to the new get() and setdefault() methods on the
...
Message object.
2001-05-22 22:00:40 +00:00
6b4593e338
Update to add get() and setdefault() as supported mapping operations, and
...
add a list of the mapping methods which are not supported (per Barry's
comments).
2001-05-22 15:12:46 +00:00
706314909b
Add some clarifications about the mapping interface presented by
...
rfc822.Message objects, based on comments from Barry.
2001-05-22 14:36:30 +00:00
1400baa5d6
Add a "See also" section with useful links. More should be added giving
...
pointers to information about the other mailbox formats; if anyone can
provide the information needed, please let me know!
2001-05-21 21:23:01 +00:00
e9719fe1a7
Fix bug in smtplib example: the prompt said to end the message with ^D,
...
but doing so raised EOFError. This makes it work as advertised and
converts to string methods where reasonable.
This closes SF bug #424776 .
2001-05-20 12:26:04 +00:00
c0dac1a58c
Beef up the unicode() description a bit, based on material from AMK's
...
"What's New in Python ..." documents.
2001-05-15 15:27:53 +00:00
ba7e2c8a27
Add some text to make the dircmp object section more readable, and move
...
some stuff around.
2001-05-11 17:01:32 +00:00
886f113ba9
--sigh--
...
Finish the last set of changes to these files so the conversion does not
break.
2001-05-11 15:49:19 +00:00
47852467f5
Markup adjustments to avoid getting junk in the index.
2001-05-11 15:46:45 +00:00
96d7a70630
Replace "\begin{classdesc}{SomeClass}{\unspecified}" with
...
"\begin{classdesc*}{SomeClass}" -- the rendering of \unspecified was
identical to \moreargs, so this helps clarify things just a little.
2001-05-11 01:08:13 +00:00
e7ec1efe50
Fix typo in weakref.proxy() documentation.
...
This closes SF bug #423087 .
2001-05-10 17:22:17 +00:00
791c351b3d
Update example to no longer use the FCNTL module.
2001-05-10 15:57:17 +00:00
e9735ac215
Remove all mentions of the strop module -- it has been pronounced Evil.
...
(The string "strop" is found in the rexec documentation, but that should
not be changed until strop is actually removed or rexec no longer allows
it.)
2001-05-10 15:05:03 +00:00
d0de57cfbb
Update the fcntl module documentation.
2001-05-09 21:09:57 +00:00
bda3a59a93
Itamar Shtull-Trauring <python@itamarst.org>:
...
Updates zipfile.ZipFile docs to mention the fact that you can create a
ZipFile instance from an arbitrary file-like object.
This closes patch #418011 .
2001-05-09 19:57:37 +00:00
c116b82b77
Work around limitations of the module synopsis table generation to avoid
...
leaking LaTeX2HTML's internal string munging.
This fixes SF bug #420399 .
2001-05-09 15:50:17 +00:00
a7c9ac6544
There is no IMAP class in the imaplib module; the class is IMAP4.
...
There is no imap module; refer to imaplib instead, since it exists.
Move the "See Also:" section in front of the sub-sections, for
consistency with other portions of the library reference.
This closes the library reference portion of SF bug #420216 .
2001-05-09 03:49:48 +00:00
1ef24e1b30
Note that when inplace=1 existing backup files will be removed silently.
...
Closes SF bug #420230 .
2001-05-09 03:24:55 +00:00
a6140be7b3
Michael Hudson <mwh21@cam.ac.uk>:
...
Documentation update to reflect changes to the termios module (noting
that the termios functions can take a file object as well as a file
descriptor).
This closes the documentation portion of SF patch #417081 .
2001-05-08 05:37:52 +00:00
f42cc45f1b
The general iteration support is part of 2.2, not 2.1 -- fixed the version
...
annotations!
Also fixed a typo noted by Neil S.
2001-05-03 04:39:10 +00:00
9cfe1824c2
Add documentation for the StopIteration exception.
2001-05-03 04:30:45 +00:00
287c4cb43a
State that Mailbox objects are iterator objects.
2001-05-02 20:22:12 +00:00
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
93656e76f9
Added section describing the iterator protocol.
2001-05-02 20:18:03 +00:00
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
82f93c693d
Only document <file>.xreadlines() once; added version annotation.
...
This closes SF bug #417943 .
2001-04-22 01:56:51 +00:00
4cacec5393
Fix a number of minor markup errors.
2001-04-21 05:56:06 +00:00
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
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
bc524c4e9f
Cut-&-paste-o noted by Wolfgang Teschner: decompressobj() returns
...
*DE*compression objects, not compression objects!
2001-04-18 20:16:51 +00:00
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
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
c054c75582
Work around the conversion of ">>" and "<<" to guillemets. Reported by Ping.
2001-04-13 17:25:38 +00:00
a3e56a6ceb
Minor markup adjustments.
...
Turn reference to the cmd module into a hyperlink.
2001-04-13 14:34:58 +00:00
4f3980d3cb
Added a test main to the pstats library that can help you browse profile dumps.
2001-04-13 00:23:01 +00:00
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
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
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
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
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
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
eedf985056
Include a synopsis for the chapter overview.
2001-04-11 19:17:11 +00:00
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
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
ac154a17a3
Remove the mapping() function from the documentation.
...
Add a description of the ReferenceError exception.
2001-04-10 19:57:58 +00:00
da00cda9fa
Add note that difflib was added in Python 2.1.
2001-04-10 19:56:09 +00:00
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
6fda3ac474
Add reference to the DDJ article discussing a similar algorithm.
2001-04-10 18:41:16 +00:00
90a72f8dcd
Add documentation for getmoduleinfo() and getmodulename().
2001-04-10 15:12:34 +00:00
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
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
501d90471d
Add entry for unittest documentation.
2001-04-07 05:42:14 +00:00
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
4cf1227e56
Change {\em ...} to \emph{...} for consistency with the rest of the Python
...
documentation.
2001-04-05 18:31:27 +00:00
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
659f377ed9
Add entry for curses.panel documentation.
2001-03-29 22:23:19 +00:00
14631f674f
Fix serious markup errors.
2001-03-29 22:22:23 +00:00
cb83988151
Added example use of weak references, contributed by Tim Peters.
2001-03-28 21:15:41 +00:00
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
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
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
ce7298ab42
Explain the difference between NL and NEWLINE.
2001-03-23 05:22:12 +00:00
c608fb6389
Give a slightly better explanation of excepthook.
2001-03-23 05:17:41 +00:00
5e0dfaccd1
Update to the most recent weakref changes.
2001-03-23 04:36:02 +00:00
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
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
b15bbc8d3d
Add documentation for SGMLParser.handle_decl().
2001-03-16 20:39:41 +00:00
f0ebbe0bd0
Re-order some method descriptions for a more logical grouping.
...
(Based on reader comment!)
2001-03-08 22:46:41 +00:00
990b0fec1a
Update documentation to reflect the shift to NetrcParseError instead of
...
SyntaxError.
2001-03-06 06:55:18 +00:00
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
043d5e5514
For copyfile(), be explicit that src and dst are file names; that was only
...
implied.
2001-03-02 16:46:42 +00:00
7606e4d00e
Added entry for urllib2 documentation.
2001-03-01 19:54:29 +00:00
f89ad5ed6b
Document configuration flags to compile for large file support on
...
certain Linux systems.
2001-03-01 18:29:57 +00:00
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
56ba72a563
Document warn_explicit().
2001-02-28 23:34:21 +00:00
7840a9cb99
Add entry for the inspect module.
2001-02-28 23:02:20 +00:00
6dbd382ec8
Clean up some of the markup for consistency, wrap some long lines.
2001-02-28 23:01:38 +00:00
58177b9975
added description of NL token
2001-02-28 22:05:41 +00:00
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
5e1633365d
Patch #403985 : Add support for weak-keyed dictionaries
2001-02-27 18:36:56 +00:00
6397c7c9a9
inspect: a module for getting information out of live Python objects
2001-02-27 14:43:21 +00:00
d4614e8371
Updates to the semantics of function and method attributes.
2001-02-27 03:32:35 +00:00
07e6c505ad
Minor adjustments, including markup corrections.
2001-02-23 19:15:56 +00:00
447f545322
Fix extra backslash in example.
2001-02-23 19:13:07 +00:00
afdc8fc0ad
Fix up the markup in some recently-added portions of the text.
2001-02-23 19:10:41 +00:00
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
7c30de65f4
Remove documentation for the soundex module; the module is no longer
...
included with Python.
2001-02-22 21:25:20 +00:00
7edbd4ffb4
Patch #103885 : Add dynamic registration and lookup of DOM implementations.
2001-02-22 14:05:50 +00:00
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
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
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
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
15bc404ca8
Added entries for difflib documentation.
2001-02-19 16:32:40 +00:00
baf71422b8
Documentation for the difflib module, converted from the module docstrings.
2001-02-19 16:31:02 +00:00
373d151666
More typos. libwinsound.tex typo noted by Peter Funk (thanks!).
2001-02-19 08:36:41 +00:00
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
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
f3262b72ca
Add entries for the doctest documentation.
2001-02-17 17:33:25 +00:00
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
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
04f1d37471
mention the use of the maxtries attribute of FancyURLopener in bounding
...
redirection recursion.
2001-02-15 17:00:40 +00:00
bf416fa0dd
Document default blocksize for storbinary().
2001-02-15 13:53:40 +00:00
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
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
1d8ad2b1de
Updated to reflect the additional information and interfaces exported in
...
pyexpat.c revision 2.40.
2001-02-14 18:54:32 +00:00
162c6a637a
Reflect change in traceback format:
...
"innermost last" --> "most recent call last"
2001-02-14 03:20:18 +00:00
e7d7e6c879
Fix two typos
2001-02-14 02:39:11 +00:00
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
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
40e43bfaf7
Document Node.isSameNode().
2001-02-03 01:20:01 +00:00
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
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
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
57d943ad38
Move the whrandom entry to the "Obsolete Modules" appendix.
2001-02-02 02:45:08 +00:00
844bd5b4a9
Minor markup adjustments.
2001-02-02 02:42:31 +00:00
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
d0946da701
Fix some markup breakage that prevented formatting; re-wrapped a couple of
...
wide paragraphs.
2001-02-01 15:53:24 +00:00
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
ebcf6a8573
Documentation for the weakref module.
2001-02-01 05:20:20 +00:00
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
30dbd1429a
Document the two changes to the mailbox.py module:
...
- All constructors grow an optional argument `factory' which is a
callable used when new message instances are created by the next()
methods. Defaults to the rfc822.Message class.
- A new subclass of UnixMailbox is added, called PortableUnixMailbox.
It's identical to UnixMailbox, but uses a more portable test for
From_ delimiter lines. With PortableUnixMailbox, any line that
starts with "From " is considered a delimiter (this should really
check for two newlines before the F, but it doesn't.
2001-01-31 22:14:01 +00:00
b416290d5d
Some rewriting of the "Internationalizing your programs and modules"
...
subsection to include a discussion of the msgfmt.py program.
2001-01-31 21:21:45 +00:00
3229b859fb
More on noutrefresh() and scroll().
2001-01-29 06:39:33 +00:00
4fda21ba6b
updated to document use of sequences of two-element tuples as inputs
2001-01-28 21:18:16 +00:00
c37f5b3296
Adjust documentation for new.instance() to reflect that the second
...
parameter may be omitted or None.
2001-01-28 17:23:05 +00:00
9ca35ec97a
Instructive example for strftime(); how to generate RFC822 dates.
2001-01-28 00:56:54 +00:00
e7213c7a80
Emphasis that instantiating this class doesn't consume the message body.
...
Fix some unclear language in the description of the addrlist member.
2001-01-27 10:56:14 +00:00
66f98b45cd
Fix a number of typos found by Guido.
2001-01-26 20:51:32 +00:00
8c071d4388
Massively improved documentation for string formatting operations,
...
primarily from Evelyn Mitchell (thanks!).
This closes SF patch #103412 .
2001-01-26 20:48:35 +00:00
e360d9507a
The combo of getstate/setstate/jumpahead is very powerful, but needs
...
examples to flesh it out for the uninitiated. Here they are.
2001-01-26 10:00:39 +00:00
29052482d1
Removed references to Python 1.5.3; that was a "tentative" number I used
...
in the docs to indicate the next version before we decided on 1.6.
Adjusted winsound.Beep() description slightly as well.
2001-01-25 17:29:18 +00:00
517ce23183
Clarify winsound.beep docs, in response to c.l.py beep brouhahalet.
2001-01-25 09:33:48 +00:00
d52269bfd0
Fix bugs introduced by rewrite (in particular, time-based initialization
...
got broken). Also added new method .jumpahead(N). This finally gives us
a semi-decent answer to how Python's RNGs can be used safely and efficiently
in multithreaded programs (although it requires the user to use the new
machinery!).
2001-01-25 06:23:18 +00:00
d7b5e88e8e
Reworked random.py so that it no longer depends on, and offers all the
...
functionality of, whrandom.py. Also closes all the "XXX" todos in
random.py. New frequently-requested functions/methods getstate() and
setstate(). All exported functions are now bound methods of a hidden
instance. Killed all unintended exports. Updated the docs.
FRED: The more I fiddle the docs, the less I understand the exact
intended use of the \var, \code, \method tags. Please review critically.
GUIDO: See email. I updated NEWS as if whrandom were deprecated; I
think it should be.
2001-01-25 03:36:26 +00:00
83125775e0
A \begin{funcdesc} was closed with an \end{methoddesc}.
2001-01-25 00:39:16 +00:00
21f37e1b88
Fixed a bug where \& was needed.
2001-01-25 00:38:15 +00:00
8ee1a4bdeb
Provide a much better (and complete!) description of the lockf()
...
function, based on an eyeballing of the code.
2001-01-25 00:36:54 +00:00
902446a28d
Supply long-missing docs for random.seed(). Extensive rewrite of module
...
intro docs.
*************** Fred: check my LaTeX! Also, the docs for whrandom should
*************** be moved into Obsolete Modules.
2001-01-24 23:06:53 +00:00
9368a12011
Fix an obvious usage nit I should have caught myself on the previous
...
change to this file. Thanks, /F!
2001-01-24 18:19:40 +00:00
fa004ad36c
Show '\011', '\012', and '\015' as '\t', '\n', '\r' in strings.
...
Switch from octal escapes to hex escapes for other nonprintable characters.
2001-01-24 17:19:08 +00:00
b1b6a11b28
AttributeList --> NamedNodeMap
...
Since there is no such thing as an AttributeList, don't say "attributes"
is one.
2001-01-24 16:17:15 +00:00
0110d3b2ad
new unicodedata functions (name, lookup)
2001-01-24 08:10:07 +00:00
eda28445c0
documented (new) optional doseq parameter to urlencode.
2001-01-24 06:36:06 +00:00
f79cb2db3e
Expose the autoraise capability. Improve the documentation.
2001-01-23 13:49:44 +00:00
aeb5532ca0
Oops...finish a mangled sentence.
2001-01-23 13:22:28 +00:00
f7f185116a
Rewrite webbrowser.py to fix various bugs following Ka-Ping Yee's
...
complaints. The new version moves most of its initialization to
package load time; it's simpler, faster, smaller, and adds support for
Mozilla and Links. Interpretation of the BROWSER variable now works
and is documented. The open_new entry point and methods are marked
"deprecated; may be removed in 2.1".
2001-01-23 13:16:32 +00:00
dc40ac0fe0
Added link to the "Python Codecs" project at SourceForge.
...
Changed markup of the list of values for the list of meaningful "errors"
values.
2001-01-22 20:17:54 +00:00
0f564eaceb
Change some wording to make this work with PDF generation -- using a PDF
...
hyperlink at the start of the paragraph confused pdflatex; it saw the
link start while still in vertical mode, which is not allowed. Including
text before the link forces horizontal mode.
2001-01-22 19:06:20 +00:00
5f0decf0d3
Clean up the docs for the "random" module according to comments from Tim
...
Peters.
This closes SF bug #125919 .
2001-01-22 18:18:30 +00:00
ef8cd7ca99
Minor markup adjustment.
2001-01-22 17:42:32 +00:00
fe385251f4
Make the 'time' argument to the timemodule functions strftime, asctime,
...
ctime, gmtime and localtime optional, defaulting to 'the current time' in
all cases. Adjust docs, add news item. Also convert all argument-handling to
METH_VARARGS. Closes SF patch #103265 .
2001-01-19 23:16:56 +00:00
6f77667a64
Backed out the unistr() builtin.
2001-01-19 21:36:19 +00:00
bc0b260a77
Minor markup cleaning, and one required fix in the unistr() description.
2001-01-18 18:09:07 +00:00
9483bed6d9
correct typo - closes bug #129205
2001-01-18 10:44:08 +00:00
3a9582fbe5
Fix the example (it didn't seem to reflect reality).
2001-01-18 07:50:17 +00:00
ad7c98e264
This patch adds a new builtin unistr() which behaves like str()
...
except that it always returns Unicode objects.
A new C API PyObject_Unicode() is also provided.
This closes patch #101664 .
Written by Marc-Andre Lemburg. Copyright assigned to Guido van Rossum.
2001-01-17 17:09:53 +00:00
90badd1286
Add a missing newline in an example; caught by Chris Ryland
...
<cpr@emsoftware.com>.
2001-01-17 05:12:13 +00:00
20ab9e9c0a
Document xreadlines() method. (Forgot to check this in before!)
2001-01-17 01:18:00 +00:00
25be1931a0
Fix a few small markup/consistency nits.
2001-01-16 20:52:41 +00:00
bd1a489759
push_source() and pop_source() entry points for shlex instances.
...
These basically just make available to the user what userhook()
does to the source stack. Documentation included.
2001-01-16 14:18:55 +00:00
Fred Drake
Martin v. Löwis
Greg Ward
Tim Peters
Skip Montanaro
Piers Lauder
Andrew M. Kuchling
Barry Warsaw
Guido van Rossum
Eric S. Raymond
Thomas Wouters
Moshe Zadka
Jeremy Hylton
Ka-Ping Yee
Fredrik Lundh
Marc-André Lemburg