Tim Peters
8cd015c701
A copy-and-paste job forget the "paste" half.
2001-10-09 20:54:23 +00:00
Tim Peters
659a60311d
Allow the profiler's calibration constant to be specified in the constructor
...
call, or via setting an instance or class vrbl.
Rewrote the calibration docs.
Modern boxes are so friggin' fast, and a profiler event does so much work
anyway, that the cost of looking up an instance vrbl (the bias constant)
per profile event just isn't a big deal.
2001-10-09 20:51:19 +00:00
Barry Warsaw
dca939899d
Fix minor cut-and-paste typo.
2001-10-09 19:37:51 +00:00
Fred Drake
e0063d20a7
Update the documentation for the isinstance() function to reflect recent
...
changes in the implementation.
Indented all descriptions consistently.
2001-10-09 19:31:08 +00:00
Barry Warsaw
a55d132f08
Add documentation for the MIMEAudio class/module, contributed by
...
Anthony Baxter.
2001-10-09 19:14:17 +00:00
Fred Drake
938a8d723c
Improve the documentation for the os.P_* constants used with the os.spawn*()
...
functions to include information about how they affect the operation of
those functions when used as the "mode" parameter.
This closes SF bug #468384 .
Added warnings to the os.tempnam() and os.tmpnam() functions regarding their
security problem. These warning mirror the warnings added to the runtime
by Skip Montanaro.
2001-10-09 18:07:04 +00:00
Fred Drake
92350b3a1f
New markup: \note{...} and \warning{...}
2001-10-09 18:01:23 +00:00
Fred Drake
6959a2fcd7
Note that the values for Boolean options are case-insensitive.
2001-10-09 14:58:24 +00:00
Fred Drake
b35f0ce2b8
Update the description of getboolean() to reflect the changes made by
...
SF patch #467580 .
2001-10-08 16:03:20 +00:00
Tim Peters
0a1fc4e389
Remove code and docs for the OldProfile and HotProfile classes: code
...
hasn't worked in years, docs were wrong, and they aren't interesting
anymore regardless.
2001-10-07 03:12:08 +00:00
Fred Drake
8c2c3d301b
Update the documentation to reflect the changes to ReferenceError.
2001-10-06 06:10:54 +00:00
Fred Drake
bf88b68f38
Add documentation for the public API for weak reference objects.
2001-10-05 22:03:58 +00:00
Tim Peters
9835206268
A regexp example was rendered as
...
foo\d
when it was clearly intended to render as
foo$
Fred, is this a right way to fix it? If not, the earlier place in the
same paragraph that does render as
foo$
is also wrong.
2001-10-05 20:06:47 +00:00
Fred Drake
e8f47bb93a
Remove some long-unsupported Mac OS modules.
...
This closes SF patch #460737 .
2001-10-05 16:49:31 +00:00
Martin v. Löwis
244edc8985
Add chroot call. Implements feature #459267 .
2001-10-04 22:44:26 +00:00
Fred Drake
fcc16330a4
Update a couple of old addresses that point to CNRI.
2001-10-04 20:40:07 +00:00
Tim Peters
3899d74c10
Make clear that tuple() accepts the same kind of arguments as list().
2001-10-04 06:53:20 +00:00
Fred Drake
6f3d82693a
Expand the documentation of the low-level tracing/profiling interface.
...
This reflects what is currently in CVS, which may change before 2.2 is final.
2001-10-03 21:52:51 +00:00
Tim Peters
0481d24dd5
CVS patch [ #466628 ] Doc changes for doctest patch ( #466616 ), from
...
Tim Hochberg. Doctest no longer searches imported objects.
2001-10-02 21:01:22 +00:00
Fred Drake
d90f509b8f
Fredrik tells me the truefalse parameter for boolean() is not part of the
...
public interface, so we can simplify the documentation.
2001-10-01 21:05:30 +00:00
Tim Peters
1350c07de3
Removed stray backslash (a typo -- my fault).
2001-10-01 20:25:26 +00:00
Tim Peters
20524dbf36
The description of dictionary comparison was out of date. Rather than
...
try to explain the complex general scheme we actually use now, I decided
to spell out only what equality means (which is easy to explain and
intuitive), leaving the other outcomes unspecified beyond consistency.
2001-10-01 20:22:45 +00:00
Fred Drake
6c81e2a44f
"boolean" --> "Boolean" (per the style guide).
2001-10-01 17:04:10 +00:00
Fred Drake
0f0380a25f
Fix some minor style-guide conformance bugs.
2001-10-01 17:04:10 +00:00
Fred Drake
fe95e65668
Straighten out some markup.
...
"boolean" --> "Boolean" (per the style guide).
2001-10-01 17:03:48 +00:00
Fred Drake
73921b0eec
Refer to the objects which define __len__(), __*item__(), and __iter__()
...
as container objects rather than as mapping objects (in the index entries).
Change the section heading and intro sentence to be a little more general,
since that's how things have actually evolved.
2001-10-01 16:32:13 +00:00
Fred Drake
e9ba525c2b
Clarify comments about mailbox objects being iterable.
2001-10-01 15:49:56 +00:00
Guido van Rossum
e7877df595
Docs for SF patch #462628
2001-10-01 13:50:15 +00:00
Martin v. Löwis
0daad598d0
Patch #462122 : add readline startup and pre_event hooks.
2001-09-30 21:09:59 +00:00
Martin v. Löwis
16dc7f44b1
Patch #462190 , patch #464070 : Support quoted printable in the binascii module.
...
Decode and encode underscores for header style encoding. Fixes bug #463996 .
2001-09-30 20:32:11 +00:00
Tim Peters
af5910f025
The execfile() docs imply it acts on locals same as exec. But in truth
...
it acts more like assigning to keys in locals(), i.e. modifications to
function locals aren't reflected in the locals when execfile() returns.
2001-09-30 06:32:59 +00:00
Tim Peters
1c33daf143
Correct docs for long(float).
2001-09-30 06:18:26 +00:00
Tim Peters
d38b1c74f3
SF [ #466125 ] PyLong_AsLongLong works for any integer.
...
Generalize PyLong_AsLongLong to accept int arguments too. The real point
is so that PyArg_ParseTuple's 'L' code does too. That code was
undocumented (AFAICT), so documented it.
2001-09-30 05:09:37 +00:00
Fred Drake
ac1af8093e
Handle PEP references the same way RFC references.
2001-09-29 19:07:22 +00:00
Guido van Rossum
0d68246f01
Fix two typos in the text about compile(), and add two caveats from
...
recent user feedback: you must end the input with \n and you must use
\n, not \r\n to represent line endings.
2001-09-29 14:28:52 +00:00
Skip Montanaro
a1c3662e84
forgot to mark use of StringType and UnicodeType in the text.
2001-09-29 13:53:21 +00:00
Skip Montanaro
c7ba0c4c24
added description of StringTypes object
2001-09-29 13:49:41 +00:00
Fred Drake
583061a10f
Fix up whitespace in <args> elements; reduce sequences of consecutive
...
whitespace characters to a single space.
Small changes elsewhere, mostly to clean up the code a little.
2001-09-29 05:05:25 +00:00
Fred Drake
2b05ca3454
Minor markup improvement.
2001-09-29 05:01:59 +00:00
Tim Peters
599db7de63
The list.sort() docs require a function that returns -1, 0 or +1. That's
...
never been true, and in particular implies cmp() can't be used(!). Get
closer to the truth.
2001-09-29 01:08:19 +00:00
Fred Drake
7988e0249c
Move XML-RPC-related docs to the "Internet Protocols" chapter.
...
Add entry for the SimpleXMLRPCServer module.
2001-09-28 22:03:40 +00:00
Fred Drake
06c61b14fe
Add entry for the SimpleXMLRPCServer module.
2001-09-28 22:02:49 +00:00
Fred Drake
e486e0d066
Preliminary documentation for the SimpleXMLRPCServer module.
2001-09-28 22:02:21 +00:00
Andrew M. Kuchling
d4707e3b62
Minor additions and rewrites.
...
Bump version number.
2001-09-28 20:46:46 +00:00
Fred Drake
3c171d1b9f
Convert to string methods.
...
For the real document element, make sure the prolog is migrated into
the document element so it isn't left stranded.
Make fixup_trailing_whitespace() whitespace do what was really intended.
Add the *desc environments used in the C API manual to the list of
things that can exist at the paragraph level so they don't get wrapped
in <para>...</para>.
2001-09-28 17:14:35 +00:00
Fred Drake
3c10c68c0e
Use consistent version annotations instead of something ad hoc.
2001-09-28 16:57:16 +00:00
Fred Drake
0f9bfd3dda
Convert most uses of the string module to string methods.
...
(string.join() lives!)
2001-09-28 16:26:13 +00:00
Fred Drake
bbf7a407e8
Added note about non-support of UNC paths on Windows.
...
This fixes SF bug #465447 .
2001-09-28 16:14:18 +00:00
Fred Drake
b387860c70
State that encode() and encodestring() append a newline to the input data
...
if it does not already end with a newline.
This fixes SF bug #463330 .
2001-09-28 16:01:46 +00:00
Fred Drake
33f4d6d1db
Add entries for the email and compiler packages.
2001-09-27 20:11:07 +00:00
Fred Drake
90e687863b
Markup adjustments.
2001-09-27 20:09:39 +00:00
Fred Drake
d443d8cc00
Added dependencies for the compiler and email packages.
...
(Migrate to branch, along with new files compiler.tex and asttable.tex.)
2001-09-27 20:08:20 +00:00
Fred Drake
e2f9917f9f
Migrate the compiler documentation from the Tools/compiler/doc/ directory.
...
Changes made to make it work in the new location.
2001-09-27 20:06:07 +00:00
Fred Drake
876389e5d8
Do not distinguish \refmodule from \module in the generated output;
...
whether or not a link will be generated will depend on the link database.
Add a couple of explanatory comments for one of the stranger constructs
(giving input an empty name).
2001-09-27 17:01:59 +00:00
Fred Drake
9213b7a961
Re-write <ulink> elements as described in the conversion spec.
2001-09-27 16:52:22 +00:00
Fred Drake
baacc08ead
Turn \input, \include, and \verbatiminput into XInclude elements instead
...
of something ad-hoc.
2001-09-27 15:49:23 +00:00
Fred Drake
b6fa78930e
Add support for some more markup that had slipped in.
...
Fixed a typo in a comment.
2001-09-27 04:18:39 +00:00
Fred Drake
3fc291a1d7
Fix some markup errors.
2001-09-27 04:17:20 +00:00
Fred Drake
b802a1e7fa
Markup adjustment: \[...\] is math markup and does not translate well when
...
used with text as was done here. Fixed so that the typeset version wraps
the warning text and the HTML version does not create images of the warning
text.
2001-09-27 04:16:27 +00:00
Fred Drake
3ab0ac7cd4
Remove comment that no longer applies.
2001-09-26 22:26:45 +00:00
Barry Warsaw
c5f8fe3a27
Updates do email package documentation for markup, style, and
...
organization.
2001-09-26 22:21:52 +00:00
Fred Drake
479384e1ff
Move the styling for the HTML version of \mailheader into the CSS file.
...
In both the HTML and typeset versions of the documentation, add a colon
after the name of a mail header so that it is more easily distinguished
from other text.
2001-09-26 18:46:36 +00:00
Fred Drake
203d91a461
Note that the colon following a mail header name should not be included
...
when using the \mailheader markup.
Change a couple of inline examples to show the markup rather than the
result.
2001-09-26 18:43:20 +00:00
Greg Ward
e22871e9ed
Typo fix.
2001-09-26 18:12:49 +00:00
Fred Drake
8b3a7b58b9
Move the \mailheader description to the right place.
...
Clarify the \mimetype description; it can be used to refer to a part of a
MIME type name, so \mimetype{text} or \mimetype{plain} can be used, not
just \mimetype{text/plain}.
2001-09-26 17:01:58 +00:00
Fred Drake
a6a885b6aa
Start making some markup adjustments; Barry has indicated he will work on
...
this before we finish the integration, along with some restructuring.
2001-09-26 16:52:18 +00:00
Barry Warsaw
5e634638e6
The email package documentation, currently organized the way I think
...
Fred prefers. I'm not sure I like this organization, so it may change.
2001-09-26 05:23:47 +00:00
Fred Drake
29a67ced72
Update to support \mailheader and 5-column tables.
2001-09-25 20:58:13 +00:00
Fred Drake
9eda3aebb8
Simplify a helper by returning fewer values.
2001-09-25 20:57:36 +00:00
Fred Drake
5055545fc0
Clarified some points about the interface to the mmap() function.
...
This closes SF bug #448918 .
2001-09-25 19:00:08 +00:00
Fred Drake
c0765c2381
Minor changes.
2001-09-25 16:32:02 +00:00
Fred Drake
c825280ea5
Revise the example to be more resiliant in the face of continued use after
...
the object has been pickled; don't mutate the instance dict in the
__getstate__() method. Other minor changes for style. Broke up the
displayed interactive session to get better page-breaking behavior for
typeset versions, and to point out an important aspect of the example.
This closes SF bug #453914 .
2001-09-25 16:29:17 +00:00
Fred Drake
9081bb1d21
Added documentation for the SSL interface, contributed by Gerhard Häring.
...
This closes SF patch #461337 .
2001-09-25 15:48:11 +00:00
Fred Drake
74f1a563ff
Fix a URL (closing SF patch #462195 ).
...
Cleaned up a bunch of XXX comments containing links to additional
information, replacing them with proper references.
Replaced "MacOS" with "Mac OS", since that's what the style guide says.
2001-09-25 15:12:41 +00:00
Fred Drake
f244b2e47c
Add more signature information and some descriptions for the new APIs
...
introduced in Python 2.2.
Add documentation for the slice object interface (not complete).
Added version annotations for several of the Python 2.2 APIs already
documented.
2001-09-24 15:31:50 +00:00
Fred Drake
23a78cf1c1
Add more reference count information.
2001-09-24 15:29:47 +00:00
Andrew M. Kuchling
1497b62827
Add link to Unix Review's 2.2 article
...
Fix two errors
2001-09-24 14:51:16 +00:00
Tim Peters
2c9aa5ea8d
Generalize file.writelines() to allow iterable objects.
2001-09-23 04:06:05 +00:00
Fred Drake
d61d0d3f6d
Added API information for the PyCallIter_*() and PySeqIter_*() functions.
...
Added signatures for some new PyType_*() functions.
2001-09-23 02:05:26 +00:00
Tim Peters
8a9c284437
Make difflib.ndiff() and difflib.Differ.compare() generators. This
...
restores the 2.1 ability of Tools/scripts/ndiff.py to start producing
output before the entire comparison is complete.
2001-09-22 21:30:22 +00:00
Tim Peters
e0b2d7ac9a
Add a function to compute a class's method resolution order. This is
...
easy for 2.2 new-style classes, but trickier for classic classes, and
different approaches are needed "depending". The function will allow
later code to treat all flavors of classes uniformly.
2001-09-22 06:10:55 +00:00
Fred Drake
038d26410d
Note that files are iterable; describe what the iterator returns.
...
This closes SF bug #463738 .
2001-09-22 04:34:48 +00:00
Fred Drake
56dd35bd44
Bump version number.
2001-09-21 21:18:16 +00:00
Fred Drake
c69205526a
Added reference to Tutorial section on user-defined exceptions for
...
information on defining new exceptions.
This closes SF bug #443559 .
2001-09-21 21:12:30 +00:00
Fred Drake
13af42822c
Exceptions in interactive examlpes did not always include the indication of
...
the source file using "in ?".
Added a description of the bare "raise" statement.
Added more description and examples for user-defined exceptions; this
is part of a response to SF bug #443559 .
2001-09-21 21:10:05 +00:00
Fred Drake
e0af35eb69
Fill in a few more descriptions for xml.parsers.expat.
2001-09-20 20:43:28 +00:00
Tim Peters
2e29bfbe1a
Document new file() constructor, with the body of open()'s text, plus a
...
"new in 2.2" blurb at the end. Replace open()'s text by pointing back
to file().
2001-09-20 19:55:29 +00:00
Fred Drake
f47d8ef683
Document all the Py*_CheckExact() functions.
...
Document many more of the PyLong_{As,From}*() functions.
2001-09-20 19:18:52 +00:00
Marc-André Lemburg
494f2aea8e
Docs and News item for the codecs.py additions.
2001-09-19 11:33:31 +00:00
Fred Drake
18d8d5a708
Fix minor usage and consistency nits.
2001-09-18 17:58:20 +00:00
Guido van Rossum
83eeef4b06
SF patch #461781 by Chris Lawrence: os.path.realpath - Resolve symlinks:
...
Once upon a time, I put together a little function
that tries to find the canonical filename for a given
pathname on POSIX. I've finally gotten around to
turning it into a proper patch with documentation.
On non-POSIX, I made it an alias for 'abspath', as
that's the behavior on POSIX when no symlinks are
encountered in the path.
Example:
>>> os.path.realpath('/usr/bin/X11/X')
'/usr/X11R6/bin/X'
2001-09-17 15:16:09 +00:00
Tim Peters
5b7759f9db
Fixed typo in new 'p' description.
2001-09-15 18:16:27 +00:00
Tim Peters
88091aae7e
SF bug [ #461674 ] struct 'p' format doesn't work (maybe)
...
Rewrote the 'p' description.
2001-09-15 18:09:22 +00:00
Tim Peters
ad2dc3fc44
Update the warning about transporting marshals across boxes with different
...
ideas about sizeof(long).
2001-09-14 20:40:13 +00:00
Fred Drake
f2a5f3f721
Markup adjustments for consistency.
2001-09-14 17:48:41 +00:00
Andrew M. Kuchling
1efd7ad88e
Add support for SMTP TLS
2001-09-14 16:19:27 +00:00
Guido van Rossum
f7fcf5eea6
SF patch #461413 (Gerhard Häring): Add STARTTLS feature to smtplib
...
This patch adds the features from RFC 2487 (Secure SMTP
over TLS) to the smtplib module:
- A starttls() function
- Wrapper classes that simulate enough of sockets and
files for smtplib, but really wrap a SSLObject
- reset the list of known SMTP extensions at each call
of ehlo(). This should have been the case anyway.
2001-09-14 16:08:44 +00:00
Fred Drake
b9a96282f1
Admit that we'll never add the args for a "call" event to the profile
...
and trace functions; this now declares that None will be passed for the
"call" event.
This closes SF bug/suggestion #460315 .
2001-09-13 16:56:43 +00:00
Fred Drake
ee0fe0b743
Add missing "}".
2001-09-12 00:43:13 +00:00
Jack Jansen
95fefc7a7a
These modules now live under the Carbon package.
...
Added a few new toolbox modules.
Noted machine dependencies for some modules.
Moved waste to undoc.tex.
2001-09-11 21:25:10 +00:00