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
83ad5015cb
effbot caught a typo!
2001-01-15 20:51:40 +00:00
773d9f09be
Document function attributes for both the function type and the method
...
type. The method documentation also includes a new brief discussion
of `bound' vs. `unbound' and why setting an attr on a bound method is
a TypeError. Includes Skip's suggested text.
2001-01-15 20:28:50 +00:00
a770e866d6
Fixing author's email address.
2001-01-15 17:08:45 +00:00
97d3b93c2f
Document changed default to passive mode.
2001-01-15 16:37:05 +00:00
77b20f099e
Document filterwarnings(..., append=<bool>).
2001-01-14 14:10:18 +00:00
1beb3d204f
Added note that this module was added in Python 2.1.
2001-01-12 22:57:32 +00:00
ca7e1ee01a
Updated descriptions to incorporate additional information from Tim Peters.
...
This mostly closes SF bug #128251 .
2001-01-11 22:49:49 +00:00
a177c40daf
Document \code{import} in pth files.
2001-01-11 22:07:25 +00:00
49c9ac30a4
Fixed minor markup nits for consistency with the rest of the library
...
reference.
2001-01-11 16:02:08 +00:00
ab78beca2f
Added pointer on POP3 variations.
2001-01-11 10:22:34 +00:00
f68f2fec7d
Implementation of PEP-0217.
...
This closes the PEP, and patch 103170
2001-01-11 05:41:27 +00:00
5ac97957f7
Corrections and additions to the documentation for POP3 and IMAP library
...
support, based on my fetchmail experience.
2001-01-11 04:19:52 +00:00
8321026ff4
SourceForge patch #103140 , checked in at fdrake's invitation. Minor fixes and
...
additions to library docs.#
2001-01-10 19:34:52 +00:00
3c48ef7de8
Added documentation for the xreadlines module & related changes. The
...
documentation was written by Jeff Epler (thanks!).
2001-01-09 22:47:46 +00:00
986eafdc2b
Added missing word; fixed minor nits.
2001-01-09 20:54:15 +00:00
37f1b34b62
Added entry for fpectl module documentation.
...
Moved the mutex docs to be adjacent to the sched docs, since these are
meant to be used together (if they are used at all!).
2001-01-09 20:52:49 +00:00
a5e7ad99d5
Documentation for the fpectl module, from Lee Busby. (Thanks!)
2001-01-09 20:38:54 +00:00
45b1d6a831
Explain that long options are matched based on a unique prefix rather than
...
requiring the whole option to be typed out.
This closes SF bug #126863 .
2001-01-08 16:05:51 +00:00
e1d4715a6f
Update explanation of the set_location() method to indicate that in
...
BTree databases, the key need not be in the database. Also, tell about
the exception if the key is not in the DB for other DB types.
This closes SF bug #127377 .
2001-01-05 06:44:19 +00:00
4e18f07613
Based on comments from Guido, do not describe bisect() and insert() as
...
being "for backward compatibility." Also revert to using bisect() in the
example, since Guido thinks that is the best recommendation for typical
usage.
2001-01-04 14:18:55 +00:00
288927f426
Markup nit: Command line options should be marked with \programopt.
...
Other minor markup nits fixed.
Make reference to PyErr_Warn() a hyperlink.
2001-01-04 05:59:37 +00:00
b162d188f6
Fix typo spotted by Detlef Lannert <lannert@users.sourceforge.net>.
2001-01-04 05:48:08 +00:00
19ae78302e
Added information about the interaction of opening a file in append mode
...
and seek() in the description of seek().
This closes SF bug #126850 .
2001-01-04 05:16:39 +00:00
22e9a5eaec
Markup nit: OK and ERR should be marked \constant in running text.
2001-01-04 05:14:45 +00:00
2a72712efe
Update documentation to include the new functions, and use the more
...
explicitly-named bisect_right() in the example code.
This closes SF bug #127055 .
2001-01-04 05:12:52 +00:00
9c15fa7a0f
Description of long(): A string parameter is no longer required to be
...
*decimal*.
This closes SF bug #127273 .
2001-01-04 05:09:16 +00:00
be0630282e
Fix doubled word
2000-12-26 16:14:32 +00:00
8694cc42ab
Remove redundant reference to tab (since it = 'horizontal tab')
2000-12-26 16:09:37 +00:00
e6bf85845f
Document ERR and OK
2000-12-26 15:58:27 +00:00
1dea760ca1
Make sure subsections are formatted into HTML pages with reasonable names.
2000-12-25 06:19:08 +00:00
f08cbb1771
Added information on the ExternalEntityParserCreate() method.
2000-12-23 22:19:05 +00:00
5caee408b8
Add 'see also' link to curses.panel
2000-12-22 22:06:43 +00:00
676634beda
Added documentation for the panel wrapper module
2000-12-22 21:57:42 +00:00
e412e7a3a0
Fix lots of small markup nits.
...
Wrapped some long lines.
2000-12-21 17:04:31 +00:00
68a6f5a0a2
Document the window.overlay() and .overwrite() methods
2000-12-21 16:25:44 +00:00
5db5ba1ee3
Document the warnings module.
2000-12-19 06:01:23 +00:00
1367b83797
Document warning categories.
2000-12-19 04:27:54 +00:00
5b56765fe7
Added documentation on the ErrorHandler interface.
...
This closes bug #126034 .
2000-12-19 04:07:54 +00:00
2b6d7bc151
Do not talk about "real" numbers; talk about "floats" or "floating point
...
numbers" instead; we have not described "reals" anywhere else in the
documentation, and this is not the place to change the story!
Reported by Keith Briggs <keith.briggs@bt.com>.
2000-12-18 13:50:24 +00:00
e9e860faf3
Add support for gdbm2 open flags ('s' and 'u'). Add module constant
...
open_flags which contains the flags supported by gdbm. Closes patch
#102802 .
2000-12-17 07:14:13 +00:00
5100133685
urlretrieve() description included explanation of "data" parameter, but
...
did not include it in the signature.
Fixed some markup nits.
2000-12-15 23:57:51 +00:00
065cba1281
Added documentation for random.shuffle().
2000-12-15 19:07:17 +00:00
29c45a5e91
Grant Griffin <grant.griffin@honeywell.com>:
...
Clarify that invert() is a *bitwise* operation.
2000-12-15 05:41:49 +00:00
4fb588240f
Document napms()
...
Add reference to demo directory
2000-12-15 01:03:23 +00:00
f0b315478b
Update information on the locking() function, added the needed constants.
...
(Thanks for the info, Tim!)
2000-12-14 03:11:24 +00:00
48971198c5
Finish a sentence that was left half-written!
2000-12-13 22:36:02 +00:00
dd802208a7
Changing allow_reuse_address's default value, and documenting it.
2000-12-13 20:39:22 +00:00
24d6da3eae
Added "stub" documentation for xml.dom.pulldom for Paul to fill out with
...
useful explanations.
2000-12-13 19:34:38 +00:00
bc9c1b15cc
Added descriptions of the defined exceptions and their mapping to the
...
DOM recommendation.
2000-12-13 17:38:02 +00:00
ff63f2023d
"Documentation" for {}.popitem().
2000-12-12 22:03:47 +00:00
ed911b8cfb
Added link to HTML version of the NumPy documentation.
...
This closes bug #124943 .
2000-12-11 20:57:13 +00:00
5255c791cc
select.select(): Add note that though this function accepts empty lists,
...
using *only* empty lists may not be acceptable on all
platforms, with the specific caveat that it does not
work on Windows. Also clarified list of acceptable
objects that may be in the lists, to let the user know
that file objects are not usable here on Windows.
2000-12-11 15:50:07 +00:00
9a29dd6580
Lots of small improvements and bits of added information on the DOM API.
2000-12-08 06:54:51 +00:00
16942f2224
Lots of additional information. Not done, but much better.
2000-12-07 04:47:51 +00:00
fd4d29cf5d
Typo caught by Jim Tittsler <jwt@onjapan.net>: They --> The
2000-12-07 00:03:24 +00:00
b62966c175
Note that, as of Python 1.6, the .returns_unicode attribute on parser
...
objects can be modified at any point with the expected results.
2000-12-07 00:00:21 +00:00
b6a54d2a2c
_getframe(): New sys module function for getting at the stack frame.
...
Implements and closes SF patch #102106 , with Guido's suggested
documentation changes.
2000-12-06 21:47:46 +00:00
21e4dd0492
Two typos caught by /F; thanks!
2000-12-04 22:29:17 +00:00
e119c8fc61
Added a comment for ContentHandler.characters() explaining how to migrate
...
SAX1 code to SAX2, based on bug #123695 .
2000-12-04 22:04:15 +00:00
57657bce94
Update Moshe Zadka's email address to one works and might last a while.
2000-12-01 15:25:23 +00:00
5725d1eb03
Backing out my changes.
...
Improved version coming soon to a Source Forge near you!
2000-11-30 19:30:21 +00:00
1a62750eda
Added .first{item,value,key}() to dictionaries.
...
Complete with docos and tests.
OKed by Guido.
2000-11-30 12:31:03 +00:00
c01f6e691b
Use a table to describe the keys to the locale information dictionary;
...
this is slightly easier to read than the list environment that had been
used.
2000-11-30 07:13:58 +00:00
e0b9deb3ce
Use small tables instead of bare \item markers to describe the contents
...
of return tuples. The bare \item took advantage of an implementation
detail when formatting in LaTeX, and was just wrong when generating HTML.
It also broke the XML conversion scripts, since there was no enclosing
list-like environment to contain them.
2000-11-30 07:12:54 +00:00
f65ab1bf10
Added entries reflecting the separation of the abstract DOM documentation
...
and the implementation docs for xml.dom.minidom.
2000-11-29 06:11:29 +00:00
eaf57aa44a
Substantial re-organization of the DOM documentation. The abstract API
...
is now separated from the supplied standard implementation. Not all
interfaces are documented yet, but the structure is better set up to do
so.
There is still a lot to do here, but the shape of the documentation is
coming into line.
2000-11-29 06:10:22 +00:00
83ff4af1a3
Added information on the use of Unicode with the StringIO and cStringIO
...
modules, otherwise the behavior is just plain confusing.
2000-11-28 16:24:28 +00:00
6763b31731
Added brief explanation of the \versionchanged for 1.5.2 (fixes formatting
...
for the HTML version).
2000-11-28 06:39:28 +00:00
2fef3abc74
Two minor nits.
2000-11-28 06:38:22 +00:00
0ac000cd54
Updates to reflect pending changes to the XML conversion process.
2000-11-22 16:42:37 +00:00
620ec9d1ca
Document the new setupterm() function
2000-11-18 17:57:33 +00:00
17383b9ad7
Added information about the %r string formatting conversion. Added note
...
about the interpretation of radix 0 for int(), and added description of
the optional radix argument for long(). Based on comments from Reuben
Sumner <rasumner@users.sourceforge.net>.
This closes bug #121672 .
2000-11-17 19:44:14 +00:00
977fe96a05
Oops, back out change committed by accident! This is not ready, and
...
breaks things.
2000-11-17 19:09:34 +00:00
2ed27d3189
Note that readframes() returns data in linear format, even if the original
...
is encoded in u-LAW format. Based on suggestion from Anthony Baxter
<anthony_baxter@users.sourceforge.net>.
This closes bug #122273 .
2000-11-17 19:05:12 +00:00
d99e534de6
Fixed typos and bug in the second example, reported by Scott Schram
...
<schram@users.sourceforge.net>.
This closes bug #122236 .
2000-11-17 18:04:03 +00:00
a3100de9ce
Fix for SF bug 122176: Error in rotor module documentation.
2000-11-14 21:43:01 +00:00
f16e0ed76c
Patch #102278 : add tparm() function to _curses module
2000-11-07 03:35:24 +00:00
a776cea71a
Document the proper exception to be raised by I/O operations on closed
...
files; error reported by Ng Pheng Siong <ngps@post1.com>.
Make sure that various special object attributes are properly indexed.
2000-11-06 20:17:37 +00:00
19647ca318
Typo: writeable --> writable
...
Reported by Erno Kuusela <erno@iki.fi>.
2000-11-01 03:12:34 +00:00
efffe8e317
Many small markup revisions to be more consistent with markup elsewhere,
...
and to provide more consistent indexing.
Added an index entry.
Added documentation for the error and XMLParserType objects.
2000-10-29 05:10:30 +00:00
3aecfc9681
Explained that os.path.basename() may return something different from the
...
basename program, as suggested by Gregor Hoffleit <gregor@hoffleit.de>.
This closes bug #119485 .
2000-10-26 21:38:23 +00:00
53143bec9b
Since LookupError can be raised by sys.setdefaultencoding(), we should not
...
document it as only being a base class, not matter how unlikely this is
to affect normal users.
2000-10-25 21:05:29 +00:00
1dba66cb72
Marc-Andre Lemburg <mal@lemburg.com> noted that the encode() string method
...
was added in 2.0.
2000-10-25 21:03:55 +00:00
8940fafabd
Additions from Marc-Andre Lemburg <mal@lemburg.com>, documenting
...
getdefaultencoding() and setdefaultencoding().
2000-10-25 21:02:55 +00:00
1491cace2a
Several additions and updates based on text from Marc-Andre Lemburg
...
<mal@lemburg.com>.
Lots of markup reformatting to make it easier for me to read & maintain.
2000-10-25 20:59:52 +00:00
277a21150b
Added entries for the xml.dom.minidom module.
2000-10-24 02:35:42 +00:00
669d36f02c
Paul Prescod <paul@prescod.net>:
...
Documentation for the xml.dom.minidom module & Python DOM API.
FLD: I have revised the markup in some places and added a few minor
details to Paul's text, but that's it. Given the substantial
structural differences with the bulk of the presentation, I will be
making additional revisions over the next few days.
2000-10-24 02:34:45 +00:00
246f65f2bb
Correct the name of a parameter in the description of the register()
...
function.
This closes bug #117467 .
2000-10-23 15:41:13 +00:00
8c2fd49cc3
Added missing entry for invert() function.
...
Added table mapping abstract operations to syntax to functions, based on
a suggestion from Bob Weiner <weiner@beopen.com>.
2000-10-22 03:19:30 +00:00
4a152630ca
Capitalize first letter of an explanation for a \versionchanged
...
annotation.
2000-10-19 05:33:46 +00:00
75afc0b914
Document the .lastindex and .lastgroup attributes of MatchObject
2000-10-18 23:08:13 +00:00
ba0a989988
Make all the \seemodule explanations consistent: start with a capitalized
...
letter and end with proper punctuation. "Documenting Python" will be
updated accordingly so that this will be editorial policy for the Python
documentation.
2000-10-18 17:43:06 +00:00
510dfbad3d
Capitalize & use periods for \seemodule explanation parameter.
2000-10-18 16:47:52 +00:00
b4b401eda3
Update the links to the NumPy website and documentation, based on a
...
comment from Janko Hauser <jhauser@ifm.uni-kiel.de>.
2000-10-17 04:58:01 +00:00
21c9df7641
For os.stat() & friends, note that the time fields are returned as
...
floating-point values.
2000-10-14 05:46:11 +00:00
602aa77d2f
Marc-Andre Lemburg <mal@lemburg.com>:
...
Documentation for the codec base classes.
Lots of markup adjustments by FLD.
This closes SourceForge bug #115308 , patch #101877 .
2000-10-12 20:50:55 +00:00
babe326c65
Added entries for new files of SAX documentation.
2000-10-12 20:07:09 +00:00
014f0e3394
Massive addition of SAX documentation from Martin von Loewis
...
<loewis@informatik.hu-berlin.de>.
Reorganized to be more like other parts of the documentation in its
arrangement, but with few content changes.
This closes SourceForge patch #101850 .
2000-10-12 20:05:09 +00:00
93615657ec
Document the exceptions that now get raised on invalid parameters.
2000-10-11 22:27:51 +00:00
6fe9bacb8c
Make sure methods of ZipFile objects are in alphabetical order; the logical
...
groupings are still maintained. Based on a comment by Steve Holden
<sholden@holdenweb.com>.
2000-10-11 18:56:00 +00:00
2c4f554b78
Fixed a large number of small problems, mostly noted by Detlef Lannert
...
<lannert@lannert.rz.uni-duesseldorf.de>.
2000-10-10 22:00:03 +00:00
66c9f0781d
Note that the UserString/MutableString classes are far less efficient
...
than the built-in string types (suggested by Moshe Zadka
<moshez@math.huji.ac.il>).
Clarified what "can be converted to a string" means.
Fixed a few markup nits.
2000-10-10 20:58:48 +00:00
ef52f601ed
Revise the examples not to use the "from socket import *", and adjust
...
one comment in the example for clarity.
2000-10-10 20:36:29 +00:00
0fc6a67307
Remove duplicated text from urlopen() description, noted by Ka-Ping
...
Yee <ping@lfw.org> and probably others as well.
2000-10-10 20:23:10 +00:00
3ece71327f
Make it clear that copy_reg.pickle() should not be used for classes, but
...
only for extension types.
This partially fixes SourceForge bug #116295 .
2000-10-10 18:36:02 +00:00
f8ca7d88c6
Fixed lots of small nits caught by Ka-Ping Yee <ping@lfw.org>.
2000-10-10 17:03:45 +00:00
2d34cd3ecf
Minor nit fixes based on suggestions from Ka-Ping Yee <ping@lfw.org>.
...
Added "See also" section with relevant RFC references.
2000-10-10 17:02:34 +00:00
25407882ea
Better synopsis based on suggestion from Ka-Ping Yee <ping@lfw.org>.
2000-10-10 16:59:53 +00:00
4d3714b5c6
Better synopses based on suggestions from Ka-Ping Yee <ping@lfw.org>.
2000-10-10 16:56:41 +00:00
6ff7aec2ab
Move the documentation for the mutex module to be with the threading
...
and queue-management modules, since that is where the general context
for use in most cases.
2000-10-10 16:46:36 +00:00
17a2b640e4
Work around annoyances in LaTeX2HTML.
2000-10-09 18:12:29 +00:00
955e03bd68
Push xmllib to the end of the markup chapter since it is deprecated.
2000-10-09 18:11:24 +00:00
3383792c74
Denis S. Otkidach <ods@users.sourceforge.net>:
...
Correct description of leapdays() function.
This closes SourceForge patch #101840 .
2000-10-09 15:27:31 +00:00
c2bac8745d
Include more information from the docstrings.
2000-10-06 21:07:14 +00:00
519744409b
Fix really bad typo, noted by Neil Schemenauer <nas@arctrix.com>.
2000-10-06 20:16:50 +00:00
c6243e4e08
Add notes on the requirements for subclasses.
...
This closes SourceForge bug #115928 .
2000-10-06 20:04:48 +00:00
2e06c209dc
Revise the versioning information to say that this was revised in 1.6,
...
not added then, and note what the change was (ncurses, change to a package).
2000-10-06 20:01:23 +00:00
062ea2e70b
Made a number of revisions suggested by Fredrik Lundh.
...
Revised the first paragraph so it doesn't sound like it was written
when 7-bit strings were assumed; note that Unicode strings can be used.
2000-10-06 19:59:22 +00:00
d88d0a1d5b
It turns out that Guido does not like or encourage the use of the term
...
"disciplines" for the __*__() methods, so they should be referred to as
"methods" or "special methods", as appropriate in context.
2000-10-06 19:39:47 +00:00
5d63a39983
is_zipfile() description: Use the same name for the parameter as the
...
code, in case someone wants to use it as a keyword paramter.
ZIP_DEFLATED description: Do not reveal the specific value of the
constant, since code should only use the symbolic name.
2000-10-06 15:29:56 +00:00
9351dd2084
Document the lookbehind assertions (closing bug#115119)
2000-10-05 15:22:28 +00:00
7a90db6131
Document expand() method of MatchObjects
2000-10-05 12:35:29 +00:00
b2c2c9e977
- update Neil's email address
2000-10-04 16:34:09 +00:00
15f06661c1
Added deprecation notices to atof(), atoi(), and atol(), recommending
...
use of the float(), int(), and long() built-ins instead.
Fixed minor markup nit elsewhere (use of \optional).
2000-10-04 13:59:52 +00:00
c71c23e392
Added \versionchanged comment to os.popen() noting that it was unreliable
...
in earlier versions of Python; this is useful information for people
interested in writing code that is portable across Python versions.
Suggested by Peter Funk <pf@artcom-gmbh.de>.
2000-10-04 13:57:27 +00:00
0b4e25d0c0
Use \obindex{...} instead of \indexii{...}{type} in many places; this is
...
more consistent with other index entries in the documentation.
2000-10-04 04:21:19 +00:00
1319e3ecbc
Remove old note that os.popen() on Windows is unreliable; this is no
...
longer true.
2000-10-03 17:14:27 +00:00
e35360ffd0
Jim Ahlstrom sent a few corrections to my changes. (Thanks!)
2000-10-03 15:16:31 +00:00
58a2dff7f4
Replace minimal \seetext references with better annotated \seerfc
...
references, telling the reader more about what to expect at the other end
of the links.
2000-10-03 05:56:55 +00:00
296b8f5bd2
Add deprecation note since the XML support is shaping up.
2000-10-02 22:14:09 +00:00
427802470a
Substantially revised documentation for the zipfile module, partially based
...
on revised text from Jim Ahlstrom <jim@interet.com>.
This closes SourceForge bug #115681 .
2000-10-02 20:56:30 +00:00
f6791f3d12
Minor usage fix.
...
Add a note that some way of reliably detecting the use of KDE would be
really nice.
2000-10-02 03:42:43 +00:00
8d3312f4d1
Add documentation and warnings for the isCallable(), isMappingType(),
...
isNumberType(), and isSequenceType() functions.
This closes SourceForge bug #115789 .
2000-10-02 03:36:18 +00:00
d15a9427e8
Fixed spelling of module; closes bug 115712.
2000-09-30 17:04:40 +00:00
58295dedf7
Replace to XXX notes to add references with real references.
2000-09-30 00:11:45 +00:00
4ce4f2eedd
os.startfile() documentation, based on text from Tim Peters.
2000-09-29 04:15:19 +00:00
8a9db99760
Updated documentation relating to the various flavors of popen[234]()
...
for Windows & Unix.
2000-09-28 20:27:51 +00:00
44774c9429
Add regex and regsub to the list of undocumented obsolete modules.
2000-09-28 05:31:39 +00:00
33dde92ecf
Update the documentation for ConfigParser to match the recent changes.
2000-09-27 22:48:44 +00:00
7f577e7fd4
regex and regsub are obsolete and Evil, so don't include them in the club.
2000-09-25 18:26:21 +00:00
e53793bf4c
Updates from Fredrik Lundh <effbot@telia.com> about Unicode-related
...
behavior.
2000-09-25 17:52:40 +00:00
ef5781b8c8
Add obsolescence note to the module descriptions that get added to the
...
list of module synopses at the front of the chapter; based on a comment
from Aahz <aahz@panix.com>.
2000-09-25 17:23:04 +00:00
d79c33a47b
Minor cleanups, wrap long lines.
2000-09-25 14:14:30 +00:00
7be3115860
Added explanation of the use of the first program argument passed to the
...
exec*() family of functions.
2000-09-23 05:22:07 +00:00
7fbc85c5c5
Rename the public interface from "pyexpat" to "xml.parsers.expat".
2000-09-23 04:47:56 +00:00
c32741d1ab
Added warnings about platform vagaries to the strptime() documentation.
...
This closes SourceForge bug #115146 .
2000-09-23 04:36:14 +00:00
544de1effb
- Add DEBUG_SAVEALL option. When enabled all garbage objects found by the
...
collector will be saved in gc.garbage. This is useful for debugging a
program that creates reference cycles.
- Fix else statements in gcmodule.c to conform to Python coding standards.
2000-09-22 15:22:38 +00:00
ed773ef78d
Include the new text on reporting bugs in a few useful places.
...
This closes SourceForge bug #114792 .
2000-09-21 21:35:22 +00:00
1bf4e93180
Convert the longest two tables from tableii to longtableii so they do not
...
make too big a mess. One actually did not fit on a single page at all!
2000-09-21 16:04:08 +00:00
fffe5dbc47
Fixed a number of small problems reported by Detlef Lannert
...
<lannert@uni-duesseldorf.de>.
2000-09-21 05:25:30 +00:00
51f53df4c8
Clarify that the softspace attribute is used by print for state management,
...
not as a user-controlled parameter.
2000-09-20 04:48:20 +00:00
f5aa4ef07c
Add entries for the xml.sax documentation.
2000-09-20 02:54:58 +00:00
e10ef74bb8
First cut at documentation for the xml.sax package (not including any
...
sub-modules).
2000-09-20 02:52:20 +00:00
752ba39a0b
Clarify a number of issues about the file-like object API based on
...
discussion on python-dev.
2000-09-19 15:18:51 +00:00
480abc2751
Document the "printable" and "punctuation" constants added to the string
...
module.
2000-09-18 16:48:13 +00:00
1675375a7c
Add missing \declaremodule for zipfile.
2000-09-18 16:21:11 +00:00
1de8098ca6
Repaired some glitches in the MD5 and SHA docs; copied the descriptions of
...
the MD5 methods into the SHA docs (substituting "sha" for "md5", of course,
and changing the stuff that depended on digest size accordingly).
Fred, don't trust me!
2000-09-18 15:34:57 +00:00
5316ef4bbb
Added documentation for new functions.
...
Deprecated sequenceIncludes().
Based on patch by Denis S. Otkidach <ods@users.sourceforge.net>,
this closes SourceForge patch #101390 .
2000-09-17 16:10:25 +00:00
6e1fecc28a
Update URL to unicode.org's FTP site using an HTTP URL to the same
...
document.
2000-09-16 13:46:42 +00:00
315b9e0ac1
Update *both* uses of the URL to the zlib home page, and use the version
...
advertised as the canonical form.
2000-09-16 06:18:26 +00:00
ab2f9f766f
Update link to the zlib homepage.
2000-09-16 05:07:03 +00:00
f29107447a
Update the link to Andrew Kuchling's crypto code.
2000-09-16 05:02:24 +00:00
91fc9319fa
Update link to the FIPS PUB 180-1 (PDF is available, but not PostScript).
2000-09-16 04:59:33 +00:00
78fc0b57df
Fixed legit gripe from c.l.py that math.fmod docs aren't confusing enough.
...
FRED, please check my monkey-see-monkey-do Tex fiddling!
2000-09-16 03:54:24 +00:00
7c25f3df85
Add some comments on the available implementations that this module can
...
use.
Change the list of flag values for open() to a table.
Markup consistency nits.
2000-09-15 21:31:31 +00:00
6634b14f3b
add cross reference to mimetools module
2000-09-15 18:20:20 +00:00
6e5184fe6a
Update comments in the second paragraph, discussing versioning issues
...
related to the BSD DB library. Based on comments from Mark Summerfield
<summer@netcraft.com>.
2000-09-15 15:19:35 +00:00
81c1735809
Add item to the list of limitations that points out the lack of support
...
for authenticated proxies. This is noted elsewhere, but this makes it
easier to find.
Fix typo where it was already mentioned.
This closes SourceForge bug #110619 .
2000-09-15 04:12:56 +00:00
4dfad57235
Add a reference to the sha module, noting that SHA is considered more
...
secure. Suggested by Erno Kuusela <erno@iki.fi>.
2000-09-14 21:47:32 +00:00
b9fd468ded
Convert "See also" section to use \seetitle.
2000-09-14 21:46:22 +00:00
6ba0a3c30a
Denis S. Otkidach <ods@users.sourceforge.net>:
...
Minor fix in documentation of code module.
(Clarifies output destination for default implementation of the write()
method.)
2000-09-14 20:42:53 +00:00
7a666b83c8
Remove reference to the stdwin-based windowed debugger, since stdwin
...
is gone.
Make a module reference into a hyperlink.
2000-09-14 20:32:17 +00:00
d5d0435617
Use \shortversion in a number of places.
...
This partially addresses SourceForge bug #114318 .
2000-09-14 20:24:17 +00:00
1fe3b82371
Avoid reference to specific versions of Python where possible.
...
This partially addresses SourceForge bug #114318 .
2000-09-14 18:25:41 +00:00
66d32b1e12
Add some index entries to make it easier to find information on
...
%-formatting of strings.
2000-09-14 17:57:42 +00:00
ddef8887db
Include a link to Francois's po-utils.
2000-09-13 12:04:47 +00:00
ae86d43f11
Add a reference item pointing to the Namespaces in XML recommendation.
...
Convert the existing reference items to \seetitle markup.
2000-09-12 17:53:48 +00:00
1349437e4c
When referring to namespaces, always say "namespaces" instead of
...
"name spaces".
Inconsistency noted by Keith Briggs <keith.briggs@bt.com>.
2000-09-12 16:23:48 +00:00
88fa9627b1
Some updates and fix a bunch of really small consistency nits.
2000-09-11 05:23:25 +00:00
1b194f927d
Add a reference to the material on string methods.
2000-09-09 05:34:06 +00:00
f96e0d203b
Various clarifications and minor nits fixed. Affected descriptions of
...
input(), locals(), reload(), unicode(), and zip().
2000-09-09 03:33:42 +00:00
1172a85175
Really minor consistency nit.
2000-09-09 03:31:17 +00:00
66571cc20c
Improve a couple of references to the language reference, making them
...
hyperlinks to relevant sections.
Clarify the conditions under which the "softspace" attribute of file-like
objects can "just work" (with relation to overriding of attribute access
in user-defined classes).
2000-09-09 03:30:34 +00:00
7acb21866c
Minor clarifications in the introductory paragraph.
2000-09-09 03:28:00 +00:00
e544191397
Add \modulesynopsis for inclusion in the list of modules at the beginning
...
of the chapter.
Add explanation that this is only available when the cycle detector is
enabled at build time.
2000-09-09 03:26:51 +00:00
1c4efad770
Move the "See also" section to a location more consistent with other
...
module sections. Properly mark the name of the module in the content
of the reference there.
2000-09-09 03:25:11 +00:00
621d2bee1c
Move description of UserString.MutableString to a location more typical
...
of the arrangement of other modules.
2000-09-09 03:23:50 +00:00
d0726c3cd9
\file is not allowed in section titles -- converting to PDF fails due to
...
weird macro-expansion issues. A better solution may be available in the
future, but this will do for now.
Add an index entry. More should probably be added as well.
2000-09-07 18:55:08 +00:00
88c023b863
Remove comment about -X and string exceptions. Error noted by
...
Justin D. Pettit <jpettit@raznick.com>.
2000-09-07 16:33:32 +00:00
6300bd42a4
Added note about Python version this was added for.
2000-09-07 14:01:40 +00:00
77a6c9ece5
Minor markup nits around use of \optional.
2000-09-07 14:00:51 +00:00
8b2e8f846c
Added a \versionadded statement to the getfqdn() description.
2000-09-06 02:22:16 +00:00
8ff4cd7512
Minor markup revisions for consistency with the rest of the documentation.
2000-09-05 13:50:21 +00:00
0d83f68fc9
Added entry for mmap module.
2000-09-05 13:49:30 +00:00
21fbd540ed
Document the new optional argument "rest" on the transfercmd(),
...
ntransfercmd(), and retrbinary() commands. This closes SF patch
#101187 .
2000-09-01 06:32:32 +00:00
65faf118b6
Fix markup error and minor consistency nit.
2000-08-31 19:35:56 +00:00
ee5adfbae6
add user-modifiable recursion_limit
...
ceval.c:
define recurion_limit (static), default value is 2500
define Py_GetRecursionLimit and Py_SetRecursionLimit
raise RuntimeError if limit is exceeded
PC/config.h:
remove plat-specific definition
sysmodule.c:
add sys.(get|set)recursionlimit
2000-08-31 19:23:01 +00:00
aef0e890b5
Document the limitation that urllib does not work with proxies which
...
require authenication. This is an implementation limitation rather than
required behavior, and may be fixed in the future.
This closes SourceForge bug #111725 .
2000-08-31 17:23:35 +00:00
4c3f797128
UNARY_NEG is supposed to be UNARY_NEGATIVE (spotted by Charles Waldman
...
<cgw@fnal.gov>).
Fix minor problem with EXTENDED_ARG description markup..
2000-08-31 16:26:35 +00:00
1c8feae411
New method getnamespace.
...
Since the application never gets to see the namespace abbreviation
used in the XML document, but some applications may need to know them,
we provide this method.
2000-08-31 10:27:00 +00:00
fcab76350a
Relocate the popen2 documentation since it is now substantially more
...
portable.
2000-08-31 06:09:26 +00:00
7b828a6a56
doc changes to parallel changes to calendar.py module
2000-08-30 14:02:25 +00:00
d576e9df5f
Markup revisions. Nothing was actually required to be able to format it,
...
but many conventions were broken.
2000-08-30 04:19:20 +00:00
28b815f28a
Oops, spell MAL's name right.
2000-08-30 03:28:17 +00:00
0691a6b8ed
Documentation for the gettext module.
2000-08-30 03:27:10 +00:00
058365aec5
Added libgettext.tex
2000-08-30 03:26:17 +00:00
a1a4b5916b
Closing patch #101120 -- After everyone agreed.
2000-08-25 21:47:56 +00:00
0308ff8652
Add reference to RFC 2396 in "See also" section.
...
Minor cleanups.
2000-08-25 17:29:35 +00:00
dfca4dc503
Revised documentation relevant to SourceForge patch #100837
...
(simplify making HTTP POST requests).
Added documentation of URLopener.version and how it can be overridden.
2000-08-25 05:13:42 +00:00
99a3701618
Documentation for poll() interface (SF patch #100852 )
2000-08-25 01:21:28 +00:00
12bba852a9
Rough and incomplete documentation on augmented assignment, which follows
...
shortly. Markup also needs checking.
2000-08-24 20:06:04 +00:00
3d0c77b37c
Addresses the other half of Bug #112634 -- the documentation suggested
...
that you can set self.version *after* calling the base class __init__.
In fact it must be done *before*.
(Fred, maybe the version class variable should be documented now?)
2000-08-24 16:20:32 +00:00
45ca3331d9
Move references to RFCs to a "See also" section for consistency with
...
other sections of the library reference.
2000-08-24 04:58:25 +00:00
9fa4d61bcc
Moshe Zadka <moshez@math.huji.ac.il>:
...
Documentation updates for urlretrieve() and URLopener.retrieve(), to
reflect Randall Hopper's patch for those functions.
This closes SourceForge patch #100837 .
2000-08-24 01:06:40 +00:00
093272ea85
Charles G. Waldman <cgw@fnal.gov>:
...
Update the dis module documentation to reflect the EXTENDED_ARG opcode.
2000-08-24 00:37:50 +00:00
297bf7ceb5
update commonprefix doc to make sure user is aware it works
...
character-by-character and that that behavior may result in it returning
prefixes that are not valid paths
2000-08-23 16:58:32 +00:00
9087688581
Describe the new PRINT_ITEM_TO and PRINT_NEWLINE_TO opcodes.
2000-08-21 17:19:00 +00:00
120beb6b67
Strengthen the warning against using SerialCookie and SmartCookie.
...
(If they're security holes, should they be documented at all?)
Minor rewrites.
2000-08-20 23:33:50 +00:00
15446d344d
Add entry for Cookie module.
2000-08-19 16:55:31 +00:00
e5c7352201
Make it format.
...
Adjust markup for hyperlinking to the relevant RFCs.
Give it a little organization.
Minor nits.
2000-08-19 16:54:57 +00:00
1b07f2bcf6
Initial revision. Markup unchecked.
2000-08-19 14:11:41 +00:00
512bb72fb0
As pointed out by Denis S. Otkidach <den@analyt.chem.msu.ru>, xrange()
...
returns an xrange object, not a range object, despite the name of the
source file they're implemented in.
In the list of comparison operators, list != before <>, since <> is
described as obsolescent.
2000-08-18 03:12:38 +00:00
304faf944c
Fix a markup error that caused formatting to fail.
...
Lots of minor markup adjustments as well.
2000-08-18 02:15:55 +00:00
0690c86a2a
Document the returns_unicode attribute
2000-08-17 23:15:21 +00:00
5215225ea1
Apply SF patch #101135 , adding 'import module as m' and 'from module import
...
name as n'. By doing some twists and turns, "as" is not a reserved word.
There is a slight change in semantics for 'from module import name' (it will
now honour the 'global' keyword) but only in cases that are explicitly
undocumented.
2000-08-17 22:55:00 +00:00
dd611b0070
A little more text, and some really minor cleanups.
2000-08-17 22:31:23 +00:00
e581bb30c4
Small cleanups, and note when zip() entered the menagerie.
2000-08-17 22:30:30 +00:00
b32aa5ecef
Revise the comments about the exceptions module to not refer to source
...
code; it is not sufficiently readable now that it in written in C, and
is less likely to be available to end users.
2000-08-17 22:29:31 +00:00
25699f99f4
Martin v. Loewis <martin@loewis.home.cs.tu-berlin.de>:
...
Document opcodes added to support extended call syntax.
2000-08-17 22:19:26 +00:00
5772c86816
Document socket.getfqdn().
2000-08-16 14:21:42 +00:00
caa658d047
Apply SF patch #101151 , by Peter S-K, which fixes smtplib's passing of the
...
'helo' and 'ehlo' message, and exports the 'make_fqdn' function. This
function should be moved to socket.py, if that module ever gets a Python
wrapper.
2000-08-15 19:30:36 +00:00
d066f6d780
Fix markup bug that prevented formatting.
...
Adjusted some markup for consistency with the rest of the documentation
and creation of the proper index entries.
2000-08-15 17:47:09 +00:00
0be4346da6
Describe the b2a_hex() and a2b_hex() functions (a.k.a. hexlify() and
...
unhexlify() respectively).
2000-08-15 06:08:00 +00:00
4ef4be53ac
Added description of the md5.hexdigest() method.
2000-08-15 06:00:28 +00:00
a2b6ad6e27
Guido pointed out that all names in the sys module have no underscore,
2000-08-15 04:24:43 +00:00
68e2915fc7
Document the byte_order value in the sys module.
2000-08-14 15:47:30 +00:00
107b9679c4
Document the range type, as suggested by Denis S. Otkidach
...
<den@analyt.chem.msu.ru>.
2000-08-14 15:37:59 +00:00
4de96c2fd8
Added Marc-Andre Lemburg's documentation for string methods, with some
...
massaging for markup consistency. This closes SourceForge patch #101063 .
Added Unicode strings and buffer objects to the list of sequence types.
Small markup nits elsewhere.
2000-08-12 03:36:23 +00:00
0be5aab04d
Merge UNPACK_LIST and UNPACK_TUPLE into a single UNPACK_SEQUENCE, since they
...
did the same anyway.
I'm not sure what to do with Tools/compiler/compiler/* -- that isn't part of
distutils, is it ? Should it try to be compatible with old bytecode version ?
2000-08-11 22:15:52 +00:00
46479d3740
Some minor clarifications and added some index entries.
2000-08-11 20:34:27 +00:00
3ac977e39c
O_BINARY: Documented this constant; omission noted by David Ascher.
...
access(): Corrected availability statement; error pointed out by
Tim Peters.
2000-08-11 20:19:51 +00:00
a8e484c8f5
getopt(): revise description of long_options parameter slightly so it will
...
be less confusing; add a paragraph separation so that comments about
the options and long_options parameters don't have references that
are easily misinterpreted.
Adjust the interactive examples to not need the string module.
Add an example showing how the module is commonly used in a script.
2000-08-11 19:55:06 +00:00
10e1bf2f64
remove all occurence of math.rint() from the sources
...
(and yes, "Currintly" also counts <0.5 wink>)
2000-08-10 04:23:30 +00:00
65983372f0
More on noutrefresh.
2000-08-09 21:49:31 +00:00
1ebd3f6c4b
Tweak curses.wrapper so it initializes colors if they are available.
2000-08-09 21:11:07 +00:00
3fe9a98c95
Correct markup error.
2000-08-09 14:37:05 +00:00
fc1f9229f4
Correct version number at which the curses.ascii module was introduced.
2000-08-09 14:36:11 +00:00
ec4b2af6bb
Fix a few markup errors and lots of small consistency issues.
...
Add "See also" link to curses.wrapper module from curses module.
2000-08-09 14:34:48 +00:00
8141cf5c76
Barry's patch to document the new setdefault() method. Slightly
...
clarified the summary for default() in the table to indicate the side
effect.
2000-08-08 16:15:49 +00:00
f9d20c3786
Neil Schemenauer: GC enable(), disable(), isenabled() interface.
...
Small stylistic changes by VM:
- is_enabled() -> isenabled()
- static ... Py_<func> -> static ... gc_<func>
2000-08-06 22:45:31 +00:00
5a007693c1
Documented curses.wrapper and curses.textpad.
2000-08-04 07:35:41 +00:00
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
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
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
6c7a46a2f0
Rob Hooft <rob@hooft.net>:
...
Description of fcntl(): Added description of what can go wrong.
2000-08-02 20:53:51 +00:00
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
f917bf6080
fixing a minor spelling mistake
2000-08-01 00:07:17 +00:00
fbd3b45bb7
Stop lying about [].pop() being experimental! There is no backing it out
...
at this point.
2000-07-31 23:42:23 +00:00
5a65c2d436
added count, extend, index, pop and remove to arraymodule
2000-07-31 20:52:21 +00:00
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
578a3f9638
Moshe Zadka <mzadka@geocities.com>:
...
Document new method in shutil (copyfileobj).
Minor clarification by Fred.
2000-07-31 15:45:46 +00:00
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
b924bd4610
Second round of curses documentation improvements. Completes and extends
...
documentation for function keys, special characters.
2000-07-27 21:10:02 +00:00
1962fb59f3
Document tiget{flag,num,str}
2000-07-26 02:59:13 +00:00
e1b304db37
Fix small typos and markup consistency nits.
2000-07-24 19:35:52 +00:00
6899660a81
First round of curses documentation improvements; correct errors, flesh out
...
entry point descriptions.
2000-07-24 03:28:40 +00:00
d372521ec0
added doc for isatty()
2000-07-19 17:30:58 +00:00
7cb1524586
added documentation for new functions {get,set}_history_length
2000-07-19 16:56:26 +00:00
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
f868de6491
Document the second round of ConfigParser changes.
2000-07-14 15:00:02 +00:00
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
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
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
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
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
146b28086f
Minor revisions similar to some information in the new docstrings.
2000-07-08 16:59:03 +00:00
c826ecbf8f
Add an entry for the KDE File Manager support from Peter Funk.
2000-07-07 17:08:40 +00:00
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
aa7524cf1f
Clean up markup to be more like recommended practice; only small changes
...
needed.
2000-07-06 18:37:08 +00:00
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
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
14ea85f325
Add entry for readline documentation.
2000-07-06 04:47:25 +00:00
011028cf74
Sjoerd Mullender <sjoerd@oratrix.nl>:
...
Updates for recent changes in xmllib.
2000-07-06 04:45:14 +00:00
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
63099f911f
added seealso pointing reader at readline example which uses atexit.
2000-07-06 03:26:39 +00:00
510ca1d338
simple-minded readline section doc based upon module's doc strings.
2000-07-06 03:25:26 +00:00
0915165096
added warning about incompatibility with other codes' use of sys.exitfunc.
2000-07-05 23:11:26 +00:00
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
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
25e7cee1c8
get_starttag_text(): Document this method.
2000-07-03 14:32:04 +00:00
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
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
fcc95a4d04
Tim-blessed documentation for math.frexp().
2000-07-03 06:38:17 +00:00
c3a65982a3
others --> other's (possessive)
...
Usage error noted by Grant Griffin <grant.griffin@iowegian.com>.
2000-07-01 17:47:38 +00:00
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
30f76ffd00
Update version numbering from 1.6 to 2.0.
2000-06-30 16:06:19 +00:00
f0e88980f3
Document randrange().
2000-06-30 15:32:31 +00:00
57a2f7f8ef
Change description of altzone to not refer to the "0th meridian".
2000-06-30 04:24:52 +00:00
9a748aa832
Say "manual page", not "man page", when referring to the Unix manual.
2000-06-30 04:21:41 +00:00
abbc7344a4
Make sure to note that this module was added for Python 2.0!
2000-06-30 03:50:06 +00:00
6e71cdd9f1
Reflect the name change to _winreg; we still need documentation for the
...
new winreg module.
2000-06-30 03:45:40 +00:00
efc43d4478
Document recently-added mouse-related functions
2000-06-30 01:05:39 +00:00
8aa3bd9098
Make it clear that id() can return either a long integer or a plain integer.
2000-06-29 03:46:46 +00:00
5c529d3f3e
Add a "See also:" link to the curses.ascii module.
2000-06-28 22:11:40 +00:00
589f44b9d0
Made the title of the Examples subsection plural!
2000-06-28 22:09:20 +00:00
be93a8332e
Added note that the atexit module was added for Python 1.6.
2000-06-28 22:07:55 +00:00
6f2a5efec9
Added entry for the curses.ascii module.
2000-06-28 22:05:44 +00:00
5ccd4b2a54
Added entries for the curses.ascii module.
2000-06-28 22:03:29 +00:00
4e716fa0ac
Skip Montanaro <skip@mojam.com>:
...
Added an example of using an HTTP POST request.
2000-06-28 21:51:43 +00:00
c82634c13c
Thomas Wouters <thomas@xs4all.net>:
...
Documentation updates related to the addition of openpty() and forkpty().
2000-06-28 17:27:48 +00:00
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
af5b76677f
Changed obsolete e-mail alias
2000-06-27 03:16:04 +00:00
f57d7b9e30
Dcoumentation for ascii.py. I've changed two references from ascii to
...
curses.ascii.
2000-06-26 23:59:24 +00:00
a4ca07cc8c
Minor grammatical fix
2000-06-21 01:48:46 +00:00
d24ff44f06
Document .timeout() method and .typeahead() function
2000-06-21 01:42:51 +00:00
0adfb45b9a
Make changes and clarifications suggested by Mark Hammond
2000-06-18 04:17:38 +00:00
b8050697b8
Documentation for the mmap module: proofreaders welcomed
2000-06-17 22:39:05 +00:00
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
fb79ffae4d
Hook in the documentation for the unicodedata module.
2000-06-13 20:51:29 +00:00
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
6b14eebae6
Documentation for the pyexpat module.
2000-06-11 02:42:07 +00:00
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
6c16019136
Fixed typo noted by Guido Kollerie <gkoller@cs.vu.nl> in example code.
2000-05-30 14:39:45 +00:00
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
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
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
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
7cb42cd070
From Greg Ward <gward@python.net>:
...
Typo: "dictionairy" --> "dictionary" (twice).
2000-05-23 02:28:26 +00:00
8c5cedee69
New description for math.frexp() -- poor description noted by
...
Francois Pinard.
2000-05-18 05:07:38 +00:00
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
71260b846e
Added math.rint() -- round according to current IEEE754 mode
2000-05-11 18:19:42 +00:00
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
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
d85f05940e
read() method: clarify that strings are accepted and interpreted
...
reasonably.
readfp() method: added documentation.
2000-05-09 15:06:32 +00:00
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
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
e06d025e00
Use \versionchanged to indicate when the second parameter to utime()
...
was allowed to be None.
2000-05-02 17:29:35 +00:00
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
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
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
ac308d0a6f
Added a "See also:" section that exhibits the \seerfc markup.
2000-04-26 18:20:04 +00:00
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
9cf7587fdc
Update change to version_info structure.
2000-04-13 17:51:58 +00:00
4d65d73686
Document hexversion (incompletely explained) and version_info (easily
...
explained).
2000-04-13 16:54:17 +00:00
ee775a194c
Make use of \longprogramopt where appropriate.
2000-04-11 19:46:40 +00:00
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
9164f88657
Fix Skip's email address in his attribution! (Thanks, Skip!)
2000-04-08 04:53:29 +00:00
c2c46c3751
New example from Skip Montanaro <skip@mojam.com>.
2000-04-07 16:09:59 +00:00
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
343301aaa4
unichr(),
...
unicode(): Added \versionadded{} annotations.
2000-04-06 15:06:03 +00:00
0b72116812
Marc-Andre Lemburg <mal@lemburg.com>:
...
Added UnicodeType.
2000-04-06 15:05:04 +00:00
56ced2a7e4
Marc-Andre Lemburg <mal@lemburg.com>:
...
Added note that Unicode strings are picklable.
2000-04-06 15:04:30 +00:00
5828ad6963
Revised / removed comments about string exceptions (relating to the
...
standard exceptions), added documentation of UnboundLocalError.
2000-04-06 15:03:01 +00:00
3cb793e8e8
Marc-Andre Lemburg <mal@lemburg.com>:
...
Added UnicodeError description.
2000-04-06 14:48:35 +00:00
61098f201e
Marc-Andre Lemburg <mal@lemburg.com>:
...
Add Unicode strings to the list of marshalable types.
2000-04-06 14:47:20 +00:00
665dd704a3
Note the exception raised when parameter to chr() is out of range.
2000-04-06 14:45:19 +00:00
33d51841a3
Marc-Andre Lemburg <mal@lemburg.com>:
...
Documentation for unichr(), unicode(), update for ord().
2000-04-06 14:43:12 +00:00
98f8a3d8da
Added codecs entry here as part of String Services.
2000-04-06 14:25:28 +00:00
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
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
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
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
898915d7e2
Noted by Guido:
...
Directionality of up/down were confused.
2000-04-05 15:01:36 +00:00
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
12ed36525a
Added "See also" section; from Peter Funk <pf@artcom-gmbh.de>
...
(re-written).
2000-04-04 20:43:50 +00:00
005f494a7f
Added "See also" section; from Peter Funk <pf@artcom-gmbh.de>.
2000-04-04 20:42:38 +00:00
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
38e5d27cae
Merged changes from the 1.5.2p2 release.
...
(Very rough.)
2000-04-03 20:13:55 +00:00
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
a22b576d05
UserString class from Peter Funk <pf@artcom-gmbh.de>.
2000-04-03 03:51:50 +00:00
3c9f936eee
Two new sections. Preliminary.
2000-03-31 17:51:10 +00:00
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
0baf773c44
Added entry for libtabnanny.tex.
2000-02-23 15:44:58 +00:00
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
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
8006d316bc
Added docs for new crc32() function. By Jim Ahlstrom.
...
(Fred, please check.)
2000-02-16 21:13:37 +00:00
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
2bb43a20ce
The dircmp module is now obsolete.
2000-02-03 15:27:26 +00:00
76e6da38c0
Document GetoptError and label error an alias.
1999-12-21 22:50:05 +00:00
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
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
88f6ca2ce9
Document getgroups(), getlogin(), fpathconf(), pathconf(),
...
pathconf_names, confstr(), confstr_names, sysconf(), sysconf_names.
1999-12-15 19:39:04 +00:00
d16b5abc07
Markup consistency nits that Guido didn't check. ;-)
1999-12-13 23:34:42 +00:00
5f7a28cdf8
Doc update from Piers Lauder see changes for imaplib.py version 2.16.
1999-12-13 23:29:39 +00:00
Fred Drake
Guido van Rossum
Eric S. Raymond
Barry Warsaw
Moshe Zadka
Jeremy Hylton
Ka-Ping Yee
Skip Montanaro
Martin v. Löwis
Tim Peters
Andrew M. Kuchling
Fredrik Lundh
Thomas Wouters
Marc-André Lemburg
Neil Schemenauer
Sjoerd Mullender
Peter Schneider-Kamp
Vladimir Marangozov
Mark Hammond