Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
21,736 Commits 6 Branches 592 Tags 2.6 GiB
Commit Graph

4654 Commits

Author SHA1 Message Date
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
Jack Jansen 945bf5f627 Added applesingle, macresource, Nav and videoreader. 
Moved icopen to its alphabetical place.
Moved waste here (from toolbox).
 2001-09-11 21:24:07 +00:00
Jack Jansen 827713a660 Added a note that these are not available under Carbon (or 
OSX MachO Python).
 2001-09-11 20:18:04 +00:00
Fred Drake 85ddfbc4cb Another documentation contributor. 2001-09-11 19:58:51 +00:00
Fred Drake 098d7fae39 Document clearly that the only way to retrieve the return code from the 
child processes is to use the Popen3 and Popen4 classes.
This fixes SF bug #460512.
 2001-09-11 19:56:51 +00:00
Fred Drake 1c66f8965a Added entry for the hmac module. 2001-09-11 16:59:42 +00:00
Fred Drake aae8da18fd Documentation for the new login() method of the smtplib.SMTP class, 
contributed by Gerhard Häring.
This is part of SF patch #460112.
 2001-09-11 16:58:00 +00:00
Fred Drake 42706803cd Documentation for the new hmac module, contributed by Gerhard Häring. 
This is part of SF patch #460112.
 2001-09-11 16:56:09 +00:00
Fred Drake 2732cb4269 Added documentation on the getfirst() and getlist() methods of the 
cgi.FieldStorage class.
This closes SF patch #453691.
 2001-09-11 16:27:03 +00:00
Fred Drake 3ae5726625 Updated infomation about libraries for alternate compilers on Windows. 
This closes SF patch #459441.
 2001-09-11 15:10:42 +00:00
Andrew M. Kuchling d6e40e24f8 Remove some XXX markers 
Update the patch and bug counts
 2001-09-10 16:18:50 +00:00
Fred Drake ed5a7ca5ee Work around a LaTeX2HTML bug that caused the "m" in "mutable" to be dropped 
in one place.
 2001-09-10 15:16:08 +00:00
Jack Jansen fda3058827 Removed an erronous comment about alias files. 2001-09-10 08:55:25 +00:00
Andrew M. Kuchling 26c39bf1b5 Add section on long integer changes 
Add removal of 3-arg pow() for floats
Rewrite introduction a bit
 2001-09-10 03:20:53 +00:00
Fred Drake 2872e8a654 Do not rebuild html-$(RELEASE).tar every time we need to use it. 2001-09-06 19:35:02 +00:00
Fred Drake c93cf676da Bump version number. 2001-09-06 19:28:06 +00:00
Fred Drake 05a73b1f9a Update link to the PyOpenGL project in the "gl" module docs. 
This closes SF bug #459256.
 2001-09-06 19:23:03 +00:00
Fred Drake 00bb329521 Document the built-in iter() function. 2001-09-06 19:04:29 +00:00
Fred Drake 7feae2d28c Bump version number. 2001-09-06 19:02:57 +00:00
Fred Drake a20c265aba Added an additional link to NIST information on secure hashing. 
This closes SF bug #458785.
 2001-09-06 18:59:43 +00:00
Fred Drake ba5c41d4c5 Clarified the interaction between string literals and continuation lines. 
Fixes bug reported as SF bug #453728.
 2001-09-06 18:41:15 +00:00
Fred Drake 8b09f4985c Make the examples for "Default Argument Values" more presentable and 
less hostile to newbie use at the interactive prompt.
This is in response to SF bug #458654.
 2001-09-06 18:21:30 +00:00
Fred Drake 9c75ff785a Fix parameter for PyInt_Check(). 
Add refcount information for other recently documented APIs.
 2001-09-06 18:06:46 +00:00
Fred Drake f8d7a5d391 Document the PyMethod_* type object, functions, and macros. 2001-09-06 17:12:44 +00:00
Fred Drake 396ca574dd Document the rule that Python.h must be included before any standard 
headers.  This is the final checkin for SF bug #458768.
 2001-09-06 16:30:30 +00:00
Fred Drake 9b88b4c9e8 Do not #include <stdio.h> since Python.h already does that. 2001-09-06 16:20:33 +00:00
Fred Drake adaca02f9e Use the standard argument convention for main(), and conform to the 
Python/C style guide.
 2001-09-06 16:17:24 +00:00
Fred Drake 4d17b303bb Several updates to cover omissions noted by Rich Salz. 
This closes SF bug #458771.
 2001-09-06 15:51:56 +00:00
Fred Drake f5072b9314 Document the "unixfrom" attribute of the rfc822.Message class. 
Based on a patch by Skip Montanaro, this closes SF bug #458885.
 2001-09-06 15:07:55 +00:00
Martin v. Löwis b0162f9afc Patch #416079: fix the debug string output when receiving telnet commands. 
added all the telnet options known to arpa/telnet.h
added all the options registered with IANA as of today
added the possibility for the user to have it's own option negotiation callback
 2001-09-06 08:51:38 +00:00
Skip Montanaro bb5a465ca9 typo... 2001-09-05 19:27:13 +00:00
Martin v. Löwis 7c82a3e0fc Patch #449815: Set filesystemencoding based on CODESET. 2001-09-05 17:09:48 +00:00
Andrew M. Kuchling 2f0047af3b Note some changes that I need to write about 2001-09-05 14:53:31 +00:00
Martin v. Löwis 44f8696171 Patch #428326: New class threading.Timer. 2001-09-05 13:44:54 +00:00
Tim Peters 7eea37e831 At Guido's suggestion, here's a new C API function, PyObject_Dir(), like 
__builtin__.dir().  Moved the guts from bltinmodule.c to object.c.
 2001-09-04 22:08:56 +00:00
Andrew M. Kuchling 33a3b63e21 Correction: the Borland C port isn't fully operational yet 2001-09-04 21:25:58 +00:00
Fred Drake 757f7809e1 Add more detail to the descriptions of the shutil functions. 
This closes SF bug #458223.
 2001-09-04 18:26:27 +00:00
Fred Drake c05fc7dd9d Added documentation for sys.maxunicode and sys.warnoptions. 
Fixed a markup error which caused an em dash to be presented as a minus sign.
This closes SF bug #458350.
 2001-09-04 18:18:36 +00:00
Tim Peters 32f453eaa4 New restriction on pow(x, y, z): If z is not None, x and y must be of 
integer types, and y must be >= 0.  See discussion at
http://sf.net/tracker/index.php?func=detail&aid=457066&group_id=5470&atid=105470
 2001-09-03 08:35:41 +00:00
Fred Drake b86677079d Move the long minidom example to a separate file; \verbatiminput does the 
right thing with page breaks in long examples, while the verbatim
environment does not.  This causes the example to wrap to the next page
instead of overwriting the page footer and bottom margin.
 2001-09-02 06:07:36 +00:00
Fred Drake 481cf2c064 Added the "Host" header to the "GET" example. 
This closes SF bug #457100.
 2001-09-01 02:35:23 +00:00
Andrew M. Kuchling 0e03f588f5 Add Jack Jansen's explanation of the MacOS X changes 2001-08-30 21:30:16 +00:00
Tim Peters d507dab91f SF patch #455966: Allow leading 0 in float/imag literals. 
Consequences for Jython still unknown (but raised on Jython-Dev).
 2001-08-30 20:51:59 +00:00
Neil Schemenauer 55cdc88c09 Update documentation for GC API. Closes SF patch #421893. 2001-08-30 15:24:17 +00:00
Fred Drake 3c0fc84b15 Update the links to the FIPS document that defines the Secure Hash 
Algorithm.  This closes SF bug #454917.
 2001-08-30 14:42:40 +00:00
Tim Peters 692323488b Add a new function imp.lock_held(), and use it to skip test_threaded_import 
when that test is doomed to deadlock.
 2001-08-30 05:16:13 +00:00
Fred Drake f9dc04341d Fix a minor markup typo. 2001-08-29 02:34:10 +00:00
Barry Warsaw da21ce3e31 On Fred's suggestion, convert sprintf() examples to use 
PyString_FromFormat().  Also fixed one grammar problem, and a few
other mark-up issues.  Sample code not checked.
 2001-08-29 01:41:58 +00:00
Andrew M. Kuchling 0ab31b8562 Add METH_O and METH_NOARGS change 
Rewrite snprintf() item a bit
Bump version number
 2001-08-29 01:16:54 +00:00
Fred Drake b5f17f2dc5 Revise comments about TeX & LaTeX for accuracy. 
This closes SF bug #456222.
 2001-08-28 18:09:11 +00:00
Fred Drake d800cff80d Added explanation that [...] * n generates shallow copies of [...], so 
the contents will be shared by multiple references.

This closes SF bug #455694.
 2001-08-28 14:56:05 +00:00
Fred Drake 5cb29a49c8 Fix a number of minor markup errors, and improve the consistency a bit. 2001-08-28 14:25:03 +00:00
Eric S. Raymond 46ccd1dae5 Plant a mention in the description of backreferences of the fact that 
while \0 doesn't do what one might expect, \g<0> does.
 2001-08-28 12:50:03 +00:00
Barry Warsaw 8c64a54f75 Refcount info for PyString_FromFormat() and PyString_FromFormatV(). 
Closes SF patch #455666.
 2001-08-28 02:32:04 +00:00
Barry Warsaw c86aa57f58 Documentation for PyString_FromFormat() and PyString_FromFormatV(). 
Closes SF patch #455666.
 2001-08-28 02:31:28 +00:00
Michael W. Hudson 53da317801 Docs for the PEP 264 changes. 2001-08-27 20:02:17 +00:00
Guido van Rossum 88e0b5bee0 SF patch #454553 by Walter Dörwald: auto-guess content-type header for 
ftp urls.
 2001-08-23 13:38:15 +00:00
Skip Montanaro 0f10f84028 indicate that mktime is platform-dependent. See SF bug 434143. 2001-08-22 12:44:27 +00:00
Skip Montanaro 5ff41d16a8 indicate that the years for which the calendar function will work are 
platform dependent.  See SF bug 434143.
 2001-08-22 12:43:38 +00:00
Fred Drake 16bb41934c New \grammartoken markup, similar to \token but allowed everywhere. 2001-08-20 21:36:38 +00:00
Fred Drake 2a274a7e41 Add another name. 2001-08-20 21:33:41 +00:00
Fred Drake cc8f44b884 Split "Extending & Embedding" into separate files, one per chapter. 2001-08-20 19:30:29 +00:00
Fred Drake 31d833d575 Added documentation for BoundedSemaphore(), contributed by Skip Montanaro. 
This closes SF patch #452836.
 2001-08-20 18:49:00 +00:00
Fred Drake 0e40c3d012 Document PyTuple_GET_SIZE(), removing confusing sentence from PyDict_Copy() 
description.

This fixes SF bug #453111.
 2001-08-20 16:48:59 +00:00
Eric S. Raymond 29bb115bae Clean up some argument profiles, enrich the docstring. 2001-08-20 13:16:30 +00:00
Tim Peters dbec7d2c16 Improve Windows time.clock() blurb; was missing return type and unit. 2001-08-19 01:38:03 +00:00
Eric S. Raymond b60f2d0977 Framework code for compilerlike scripts. 2001-08-18 09:24:38 +00:00
Barry Warsaw dbfe5e8507 Document that uu.decode() will always raise a uu.Error if out_file 
isn't given, and the file in the uu header already exists.  Also add a
description of the uu.Error exception class.
 2001-08-17 20:01:06 +00:00
Fred Drake 2dc07946bf Make sure that ampersand escaping is still performed on the contents of 
local module tables (the lists of modules documented within a chapter,
inserted at the beginning of the chapter).  If this is not done here,
the text is not part of the resulting documents when latex2html does the
processing normally.

This fixes a little bit more of SF bug #451556.
 2001-08-17 17:20:44 +00:00
Fred Drake cb19976f1a fix_font(): Instead of using a long if/elsif cluster, use a bloody 
dictionary.  Added some entries to the dictionary to fix part of
    SF bug #451556.
 2001-08-16 21:56:24 +00:00
Fred Drake 457c4190f9 Fix typo reported by Joonas Paalasmaa: dada-->data 2001-08-16 21:25:24 +00:00
Fred Drake 739282da83 Re-write the description of the os.spawn*() functions, and cover the 
whole family instead of just two.


This closes SF bug #451630.
 2001-08-16 21:21:28 +00:00
Martin v. Löwis e3eb1f2b23 Patch #427190: Implement and use METH_NOARGS and METH_O. 2001-08-16 13:15:00 +00:00
Fred Drake ce1650f3a5 A large contribution from Dave Kuhlman describing what each of the slots 
in the type object is used for, for many of the more commonly used slots.
Thanks!

(But there is still a lot more to write on this topic.)
Markup and organizational changes by your friendly neighborhood
documentation czar.
 2001-08-15 19:07:18 +00:00
Fred Drake 87731762f2 Dave Kuhlman has contributed a nice improvement to the "Defining New Types" 
section of the Extending & Embedding manual -- thanks!
 2001-08-15 19:00:29 +00:00
Andrew M. Kuchling 94a7eba9db Note addition of cleanfuture.py 2001-08-15 15:55:48 +00:00
Fred Drake ce575bac5e Fix a minor typo and mark an exception name that was missed. 2001-08-14 21:51:50 +00:00
Fred Drake c0cf726d8c Add material about the "r" and "u" prefixes for string literals; should 
be reviewed for clarity.

Work around a bogosity in the HTML version of the escape sequences table
conversion.
 2001-08-14 21:43:31 +00:00
Fred Drake 0cac5f697b Added some examples of table markup. 2001-08-14 21:36:19 +00:00
Fred Drake 3e2aca48bd Add information about __floordiv__() and __truediv__() methods for 
implementing numeric objects in Python.
 2001-08-14 20:28:08 +00:00
Fred Drake d3ba10f4b5 Clarify the prompt in an example. 
This closes SF bug #450633.
 2001-08-14 19:55:42 +00:00
Barry Warsaw 5ef99a0bc5 Describe the new semantics for setting and deleting a function's 
__dict__ attribute.  Deleting it, or setting it to a non-dictionary
result in a TypeError.  Note that getting it the first time magically
initializes it to an empty dict so that func.__dict__ will always
appear to be a dictionary (never None).

Closes SF bug #446645.
 2001-08-14 18:22:24 +00:00
Fred Drake 680cabb225 Add "exceptions" to the list of fundamental modules 
created by Py_Initialize().

This closes SF bug #450621.
 2001-08-14 15:32:16 +00:00
Fred Drake 280f7253e4 Insert omitted "the". 2001-08-14 11:42:13 +00:00
Fred Drake bf781a95c0 Add the smtpd module to the list of undocumented modules; Barry needs to 
write the documentation for this module.
 2001-08-14 11:38:35 +00:00
Fred Drake 6943a29cbf David Goodger <dgoodger@atsautomation.com>: 
Documentation for difflib/ndiff refactoring: more of the ndiff functionality
has been moved to the underlying library (difflib).

This closes SF patch #445413.
 2001-08-13 19:31:59 +00:00
Fred Drake 84e58ab722 For the escape() function, added a reference to the quoteattrs() function 
in xml.sax.saxutils, since that is the right function to use for quoting
attribute values.
This closes SF bug #444707.

Cleaned up a variety of other minor markup errors.
 2001-08-11 03:28:41 +00:00
Andrew M. Kuchling 9e9c1358e8 Add section on PEP 238 changes 
Minor grammatical changes, reformattings, and an error fix from Keith Briggs
 2001-08-11 03:06:50 +00:00
Fred Drake 1cf0f1751f Add a note that the quoteattr() function is useful for HTML and SGML 
attributes as well.
 2001-08-10 22:14:17 +00:00
Fred Drake 11ee90289c Added documentation for PyDict_Update() and PyDict_Merge(). 2001-08-10 21:31:12 +00:00
Fred Drake 1cb560a653 Do more to be compatible with Windows/CygWin. Make error messages more 
informative when a child process dies with an error.

This is a variation of parts of SF patch #429611.
 2001-08-10 20:17:09 +00:00
Fred Drake 9443dc31c1 Remove the use of the "cat" program. This improves portability to non-Unix 
platforms.

This is part the response to SF patch #429611.
 2001-08-10 20:12:09 +00:00
Fred Drake 8a7b59e7b4 Added this LaTeX style file to the package since not all LaTeX installations 
have it, especially on non-Unix platforms.  (MikTeX in particular does not
have it.)

This is part of the response to SF patch #429611.
 2001-08-10 19:47:41 +00:00
Fred Drake d635e3c468 Added a warning about reference cycles and memory consumption to the 
section on functions which return stack frames.

This closes SF bug #449258.
 2001-08-10 17:37:33 +00:00
Fred Drake 6d8d72b0cb Usage fix, problem reported by Keith Briggs. 2001-08-10 16:15:08 +00:00
Fred Drake e89659c02d Added documentation for the new rich comparison support. 
This closes SF patch #428320.

Added documentation for the new floordiv() and truediv() functions.
This is part of SF bug #449093.

Re-organized the listing of functions to get better logical grouping.
 2001-08-10 15:55:09 +00:00
Fred Drake 024ef6f493 Remove the bogus flags parameter from the PyFile_WriteString() signature; 
it has no such parameter.

This closes SF bug #449761.
 2001-08-10 14:27:38 +00:00
Martin v. Löwis 9b75dca192 Expose nl_langinfo through locale where available. 2001-08-10 13:58:50 +00:00
Martin v. Löwis 8cc965c1fb Patch #448474: Add support for tell() and seek() to gzip.GzipFile. 2001-08-09 07:21:56 +00:00
Fred Drake 0197858f62 Added documentation for PyNumber_*FloorDivide(), PyNumber_*TrueDivide(), 
PyInterpreterState_*Head(), PyInterpreterState_Next(), and
PyThreadState_Next().

Wrapped some long lines, added some others.
 2001-08-08 19:14:53 +00:00
Fred Drake 03590c6bdc Reference counting information for PyNumber_*FloorDivide() and 
PyNumber_*TrueDivide().
 2001-08-08 18:50:18 +00:00
Fred Drake e54acfd8b2 Add option to push the development docs to SF without announcing, for 
when the changes are just too small.
 2001-08-08 05:41:01 +00:00
Fred Drake ecab00176f More names.... 2001-08-08 05:39:52 +00:00
Fred Drake 3a5ec57456 Clean up some of the markup here -- be more consistent in the use of 
semantic labels instead of presentational markup.
 2001-08-08 05:39:29 +00:00
Fred Drake a7d608d1cf "Thin" version of floor division docs: add // to the list of operators 
and //= to the list of other delimiter tokens.

I'll work on it again when it's not so late...
 2001-08-08 05:37:21 +00:00
Andrew M. Kuchling 8c69c91be3 Document two new items 
Correct error noticed by Keith Briggs
Re-indent a paragraph
 2001-08-07 14:28:58 +00:00
Fred Drake 58212724f2 Add a comment on time.time() returning non-decreasing values except when 
the clock is set back.

This closes SF bug #447945.
 2001-08-05 15:43:04 +00:00
Martin v. Löwis c9908c4f5c Document IPv6 changes. Contributed by itojun. 2001-08-04 22:22:45 +00:00
Fred Drake 53765753c4 Lots of new text and example code on embedding Python in C, contributed 
by Albert Hofkamp.  Some editing has been done for style and markup
consistency.

This also supplies an example of importing modules and calling a function
defined in the module, so this closes SF bug #440037 as well.

(The long example code was moved to a separate file so that it would
format properly.)
 2001-08-04 01:58:36 +00:00
Fred Drake b3cc29b493 Note that the mimetypes.MimeTypes class was added in Python 2.2. 2001-08-04 00:48:49 +00:00
Fred Drake d5efb17086 Add documentation for the new aspects of the mimetypes module. 
This closes the SF bug (feature request) #439710.
 2001-08-03 21:03:14 +00:00
Fred Drake d86038d1be Apply the new \mailheader macro where appropriate, and fix a few small 
markup inconsistencies.
 2001-08-03 18:39:36 +00:00
Fred Drake 7eac0cb04c Define the \mailheader macro and document conventions for using it. 2001-08-03 18:36:17 +00:00
Fred Drake 30cf118cf7 Minor markup nits and slight style-guide conformance changes. 2001-08-03 17:11:33 +00:00
Jack Jansen cb60dae6a1 Documented the runtimemodel attribute. 2001-08-03 13:19:56 +00:00
Fred Drake 5d54879647 Fix some of the example code; the reference objects do not support a 
get() method; just calling them is sufficient.  (There was a get() method
for this in an early version of the implementation.)

Reported by Mats Wichmann.
 2001-08-03 03:50:28 +00:00
Fred Drake 8dd6ffd0ec User-defined methods *can* contain things other than user-defined functions 
as the callable, so use more flexible language.
 2001-08-02 21:34:53 +00:00
Fred Drake 51629c245a Add a caveat about boundary conditions and RE concatenation, so that the 
documents do not make an overly-strong assertion about the properties of
RE concatenation.

Add an example of RE{m,} syntax and what it will and will not match.
 2001-08-02 20:52:00 +00:00
Fred Drake f90490ef94 Move away from apply() to using extended call syntax for some example 
fragments when discussing equivalence of thhe C API to what a Python
programmer sees.

Added descriptions of PyEval_SetProfile() and PyEval_SetTrace().
 2001-08-02 18:00:28 +00:00
Fred Drake 044bb4d22a Explain that __init__() methods do not get to return values. 2001-08-02 15:53:05 +00:00
Fred Drake 388f37e6f6 Add anentry for the distutils.sysconfig module docs. 2001-08-02 15:13:58 +00:00
Fred Drake ab70b38367 Update some incorrect comments about the bdist commands that exist. 
Add an entry for the distutils.sysconfig module docs.
 2001-08-02 15:13:15 +00:00
Fred Drake 25376c4f8b Documentation for the distutils.sysconfig module. 2001-08-02 15:12:07 +00:00
Fred Drake 905dc558f1 Cleaned up the description of readline.set_completer(). 
Thanks to Nathaniel Gray for reporting the confusion.
 2001-08-01 21:42:45 +00:00
Fred Drake 236ddd6834 Added more names. 2001-08-01 17:19:11 +00:00
Fred Drake 20c94913de Minor re-wording in the exaplantion of sequence comparisons. 
This closes SF bug #445749.
 2001-08-01 17:17:13 +00:00
Fred Drake e74f8de385 Added an example of a string value for the replacement parameter to 
re.sub().
This closes SF bug #446136.

Fixed description of RE modifiers so that RE{#} and RE{#,} are more
clearly described and disambiguated (plain RE{#} had not been described
at all).  Reported by Jeremy Craven via email.
 2001-08-01 16:56:51 +00:00
Fred Drake 630a63cafd Fix description of buffer_info(), and add a note that there is a better 
way...

This closes SF bug #444842.
 2001-08-01 16:50:49 +00:00
Andrew M. Kuchling 77707673f4 Move C-level changes into a section of their own 
Add string.ascii_letters
Remove duplicate MBCS paragraph
 2001-07-31 15:51:16 +00:00
Andrew M. Kuchling f4ccf587f6 Rewrite MBCS paragraph following MH's suggestions, and credit him 
Note new Windows installer
 2001-07-31 01:11:36 +00:00
Fred Drake 43211ecda2 Make some adjustments to the markup, and fix up some style-guide issues. 2001-07-29 03:41:23 +00:00
Martin v. Löwis 66b6e192b9 Patch #416224: add readline completion to cmd.Cmd. 2001-07-28 14:44:03 +00:00
Greg Ward 54f65094c3 Typo fix. 2001-07-26 21:01:21 +00:00
Tim Peters 7321ec437b SF bug #444510: int() should guarantee truncation. 
It's guaranteed now, assuming the platform modf() works correctly.
 2001-07-26 20:02:17 +00:00
Martin v. Löwis 4f1cd8bdcb Patch #411138: Rename config.h to pyconfig.h. Closes bug #231774. 2001-07-26 13:41:06 +00:00
Skip Montanaro 41d7d58cc4 trivial rewording in footnote 5. 2001-07-25 16:18:19 +00:00
Fred Drake d61e3eab44 Add entry for the new distutils section. 2001-07-24 16:20:13 +00:00
Fred Drake 4fefcc3ce4 Overview comments for the distutils package, with links to the distutils 
manuals for more information.  This is being added to make it easier to
find the documentation for the distutils code.
 2001-07-24 16:19:24 +00:00
Fred Drake f1b3de8d5c Add labels to all \section and \subsection headings for use in references. 2001-07-24 14:38:34 +00:00
Fred Drake c547b46c06 Be more specific about corner cases in the description of the $ RE syntax, 
and include an example where the MULTILINE flag makes a real difference.

This closes SF bug #441600.
 2001-07-23 21:14:59 +00:00
Fred Drake 6fd3b22847 When explaining the enterabs() method, using the modern spelling of apply(), 
and relax the type of the argument list from tuple to sequence.
 2001-07-23 19:28:09 +00:00
Fred Drake 6fdb90c0ca Remove self-reference from the anydbm module. 
This closes SF patch #443788.
 2001-07-23 19:22:42 +00:00
Fred Drake 8a2adcf812 Typo: Added missing "if". 
This is part of SF patch #442788.
 2001-07-23 19:20:56 +00:00
Fred Drake c046e97dc2 Add StopIteration to the list of exceptions *not* derived from StandardError. 
Slightly re-word discussion of SystemExit and fork().
This is part of SF patch #443788.
 2001-07-23 19:19:39 +00:00
Fred Drake 63bc2e0fcb Convert the use of apply(f, args) to the new spelling: f(*args). 
This is part of SF patch #443788.
 2001-07-23 19:16:22 +00:00
Fred Drake 3332778f35 Corrected a section reference (title was wrong). 
Added information on the return values of PyArg_ParseTuple() and
PyArg_ParseTupleAndKeywords().
 2001-07-20 20:59:49 +00:00
Fred Drake 88fdaa7c9e Typo: PyArgs_ParseTuple --> PyArg_ParseTuple 
Moved the PyArg_Parse*(), Py_BuildValue() functions to the Utilities
chapter, added a minimal description and reference to the Extending
manual for Py_BuildValue().
 2001-07-20 20:56:11 +00:00
Fred Drake 6d988559a3 Added information on Py_BuildValue(). 2001-07-20 20:55:31 +00:00
Fred Drake f69868f304 Add a missing "\" to the markup. 2001-07-20 19:03:44 +00:00
Fred Drake 960fdf9ac3 Added the constants ascii_letters, ascii_lowercase, and ascii_uppercase 
to the string module.  This was determined to be the right approach in
SF bug #226706.
 2001-07-20 18:38:26 +00:00
Andrew M. Kuchling a6d2a04065 More Unicode corrections from MAL to match a post-2.2a1 change 
Mention additional new imaplib.py features

(Don't expect to see an updated version of the Web page until around the 28th
   of July.  Vacation time!)
 2001-07-20 18:34:34 +00:00
Fred Drake 9079164bdf Removed unnecessary section "Unicode literals"; all the discussion is 
already present in the "String literals" section, including comments on
the "u" prefix and the additional escape sequences used for Unicode.

This relates to SF bug #442526.
 2001-07-20 15:33:23 +00:00
Fred Drake 0825dc2427 Fix typo in description of raw strings: "value" --> "valid" 
This closes SF bug #443059.
 2001-07-20 14:32:28 +00:00
Piers Lauder a3a1668904 apply patch item #416254 2001-07-20 11:04:19 +00:00
Andrew M. Kuchling 5120eac6c6 Bump release number to 1.00, while I'm at it 2001-07-20 03:22:00 +00:00
Fred Drake acd32d3be5 Added function xml.sax.saxutils.quoteattr(). 
This closes SF bug #440351.  It should not be moved to Python 2.1.1.
 2001-07-19 16:10:15 +00:00
Andrew M. Kuchling ab01087109 Revise the Unicode section after getting comments from MAL, GvR, and others. 
Add new low-level API for interpreter introspection
Bump version number.
 2001-07-19 14:59:53 +00:00
Fred Drake 53d285a9af Remove some false statements. 2001-07-19 03:49:33 +00:00
Andrew M. Kuchling f5fec3c88a Fill out the Unicode section, somewhat uncertainly 2001-07-19 01:48:08 +00:00
Andrew M. Kuchling 8cfa9055cf Finish the "Other changes" section 
Bump version number
Insert a few blank lines here and there
 2001-07-19 01:19:59 +00:00
Andrew M. Kuchling 28bafb8b5d Fix a few typos 2001-07-19 01:17:15 +00:00
Andrew M. Kuchling b39fa8a75b Remove note about this being a draft document. 
Note the actual date of 2.1's release
 2001-07-19 00:29:48 +00:00
Fred Drake 5afb5e5c9c Look to the future: bump the version number. 
Do more to ensure we don't do any more formatting than we need to.
Use separate targets for the distribution packages for paper-based and
non-paper-based formats; this avoids some extra packaging when a complete
distribution is being built with both paper sizes.
 2001-07-18 21:17:29 +00:00
Fred Drake 413bfb766e 2.2a1 is out; look to the future. 2001-07-18 21:06:06 +00:00
Fred Drake cb417c0724 Ignore all .tar files in the top directory; we're about to generate 
more of them.
 2001-07-18 21:04:35 +00:00
Fred Drake 6c29926587 Lots of small updates, some long overdue. 2001-07-18 20:01:15 +00:00
Fred Drake 01815526e0 Add a more substantial example startup file for the interactive shell; 
sample startup script provided by Itamar Shtull-Trauring.

This closes SF patch #410890.

Add some logical markup where it was missing.
 2001-07-18 19:21:12 +00:00
Fred Drake 1ca78b6b70 Change the command lines to use a similar "phrasing" to that used in the 
other documentation makefiles.  This is probably not sufficient to run
the conversion on Windows, but goes at least part way.
 2001-07-18 18:32:38 +00:00
Fred Drake 72182027a8 "Make small changes, but carry a big diff." 
Minor local consistency adjustments.
A couple of small tweaks to the setdlopenflags() description.
For setprofile() and settrace(), convert some references to become
hyperlinks in the HTML version.
 2001-07-18 17:52:58 +00:00
Fred Drake 1a2302b3b2 Add some symbolic names to support hyperlinked references. 2001-07-18 17:40:19 +00:00
Fred Drake 5d808fba00 Made a few minor style & markup changes to the new {get,set}dlopenflags() 
descriptions; added availability notes.
 2001-07-18 16:35:05 +00:00
Martin v. Löwis f0473d511b Patch #412229: Add functions sys.getdlopenflags and sys.setdlopenflags. 
Add dlopenflags to PyInterpreterState, and use it in dlopen calls.
 2001-07-18 16:17:16 +00:00
Fred Drake b311ad5bcb Ignore the html-*.tar file that can now be generated as an intermediate. 2001-07-17 23:36:31 +00:00
Fred Drake 8f65aeffbd Revise the rules for building the distribution files for the HTML format. 
These work again.
 2001-07-17 23:35:46 +00:00
Fred Drake 0068e9c1eb Mirror Guido's latest changes to the license file. 2001-07-17 23:08:24 +00:00
Fred Drake 5e06b84092 Be more specific about some of the dependencies, to avoid re-building when 
some of the mostly-general files get changed.
 2001-07-17 23:07:03 +00:00
Fred Drake f269e59232 Define new markup for 5-column tables. 2001-07-17 23:05:57 +00:00
Fred Drake 3a3bb211c8 Kill another merge zombie. 2001-07-17 21:05:22 +00:00
Fred Drake c4fefb19cf Kill a merge zombie. 2001-07-17 21:04:18 +00:00
Fred Drake efaef13c81 Update the availability information for os.tempnam(), os.tmpfile(), and 
os.tmpnam().
 2001-07-17 20:39:18 +00:00
Fred Drake 68db730324 Adding what's done of the documentation for the new profiling & 
tracing interface.  Incomplete, but better to check it in since I've
been including it in my updates.
 2001-07-17 19:48:30 +00:00
Andrew M. Kuchling c32cc7c11d Delete sentence fragment (noted by Fred Bremmer) 2001-07-17 18:25:01 +00:00
Fred Drake 1385a57b85 Bump the release number. 
Make the syntax of compound command lines more portable (nmake, CygWin).
These changes are an adaptation of SF patch #429611.

Use the new tools/rewrite.py instead of grep/date/sed to transform
html/index.html.in into html/index.html; this is required for portability.
 2001-07-17 16:53:19 +00:00
Fred Drake 16649a803b Make the syntax for compound command lines more portable (nmake, CygWin). 
This is probably not sufficient by itself for the info generation, and is
being done mostly to keep the style consistent with additional patches
that will be applied to Doc/Makefile.
 2001-07-17 16:48:55 +00:00
Fred Drake 3cae66bdbc Script to re-write @FOO@-style marks with values, initializing the 
replacement for @DATE@ from a TeX file containing a \date{...} mark
(such as texinputs/boilerplate.tex).

This will be used to re-write the html/index.html.in file instead of
a combination of grep, date, and sed -- this is more portable to non-Unix
platforms.

This solves part of the problem reported in SF patch #429611, but does
not use the suggested patch.
 2001-07-17 16:46:14 +00:00
Fred Drake 63d1d264d1 Update the release information. 2001-07-17 16:28:50 +00:00
Fred Drake f8a17b14c4 Now we're picking nits: get my name right! ;-) 2001-07-17 14:54:07 +00:00
Andrew M. Kuchling 6ea9f0bb20 Add FLD to credit list 
Correct grammatical error
 2001-07-17 14:50:31 +00:00
Fred Drake aebbca3b61 Job.__init__(): Only create the builddir directory if it will be used (by 
building the HTML or text documentation).  There is no need to create
    it for other formats.

Job.build_html():  The builddir parameter is always passed in, so it need
    not be optional.
 2001-07-17 14:46:09 +00:00
Fred Drake 0d00254cc1 Cleaned up a number of minor nits, use markup a little more consistently. 2001-07-17 13:55:33 +00:00
Andrew M. Kuchling 4cf52a9a80 Minor rewrites to iterator and generator sections 
Credit both Neil and Tim for generators
Fix indentation of a few paragraphs
 2001-07-17 12:48:48 +00:00
Fred Drake e78661bf90 Fix a couple of minor markup nits. 
Footnotes should be added *after* punctuation, not before.
(Yes, this should be merged with the descr branch.  Sorry, Tim!)
 2001-07-17 05:17:58 +00:00
Barry Warsaw 95400a28e4 Updated the documentation in several respects: 
- This module, despite its name, now should conform to RFC 2822, the
  update to RFC 822.

- This module doesn't just represent "email headers", but entire email
  messages.

- Added documentation for other useful public functions such as
  quote(), unquote(), praseaddr(), and dump_address_pair().
 2001-07-16 20:47:58 +00:00
Fred Drake 687a17deaa Revise the description of time.clock() so that it correctly describes the 
Windows version of the function as well as the Unix flavor.

This fixes SF bug #441357.
 2001-07-16 15:40:57 +00:00
Andrew M. Kuchling ddeb1358a4 Use \longprogramopt, as suggested by FLD 2001-07-16 14:35:52 +00:00
Andrew M. Kuchling ced2366a05 Use \verb for configure switches, because inside \code multiple dashes 
are merged to a single hyphen.
Delete forgotten CVS conflict marker
 2001-07-16 13:45:31 +00:00
Andrew M. Kuchling 2cd712b812 Write some entries in the "Other changes" section 
Write description of .encode()/.decode for the Unicode section
Bump version number
 2001-07-16 13:39:08 +00:00
Andrew M. Kuchling 4dbf87152e Began actually writing: 
* iterators
* generators
* copied the nested scopes section from the 2.1 article
* standard library changes
 2001-07-16 02:17:14 +00:00
Fred Drake 44845ba67d Change the target name for \kbd. 2001-07-14 03:10:20 +00:00
Fred Drake 9725fd8c26 Add another name. 2001-07-14 03:09:29 +00:00
Fred Drake 755c23dcc4 Oops, one more caret. 2001-07-14 03:05:53 +00:00
Fred Drake 377fb1e1f6 Fix the markup of the caret charater in a couple of places; LaTeX's 
special character bite us again.  ;-(

This fixes SF bug #440911.
 2001-07-14 03:01:48 +00:00
Fred Drake 8ee679f0ce Minor changes to match the style guide. 2001-07-14 02:50:55 +00:00
Fred Drake 4124a0b343 Correct a couple of errors noted by Alex Martelli. 2001-07-14 02:46:01 +00:00
Fred Drake 7fc8abb396 Remove comments about XML and HTML; those sections are no 
longer part of this chapter.

Minor change to match the style guide.
 2001-07-14 02:44:43 +00:00
Fred Drake 9120df388c Add a little more information about the usage of some terms where the 
style guide can use a little clarification, and present some minor
specific markup.

Make a few adjustments to conform to the style guide.
 2001-07-14 02:34:12 +00:00
Fred Drake 7a889ceb1e Minor change to match the style guide. 2001-07-14 02:27:22 +00:00
Fred Drake 17f690f96b Minor changes to match the style guide. 2001-07-14 02:14:42 +00:00
Fred Drake 6e5e1d924c Minor change to match the style guide. 2001-07-14 02:12:27 +00:00
Fred Drake 8da359bdc0 Minor changes to match the style guide. 
Make the reference to the python-docs email address a hyperlink; we want to
encourage responses to the plea for help!
 2001-07-14 02:09:32 +00:00
Fred Drake 3d97e35a20 Add entry for xmlrpclib documentation. 2001-07-12 23:40:13 +00:00
Fred Drake 5ddf7adf84 Several markup adjustments so this will format and be more consistent with 
the rest of the documnentation.
 2001-07-12 23:39:24 +00:00
Fred Drake 602cf584be Generate a more meaningful message regarding the type of the documentation 
release being discussed.
 2001-07-12 21:50:10 +00:00
Fred Drake f4bdb57e15 Fix return value for m.group() for groups not in the part of the RE that 
matched; reported by Paul Moore.

Wrapped several long lines.
 2001-07-12 14:13:43 +00:00
Guido van Rossum bf5a774bcb On int/long to the negative int/long power, let float handle it 
instead of raising an error.  This was one of the two issues that the
VPython folks were particularly problematic for their students.  (The
other one was integer division...)  This implements (my) SF patch
#440487.
 2001-07-12 11:27:16 +00:00
Eric S. Raymond e304bb9eec First version of xmlrpclib docs. Probably has markup errors; is not complete, 
could probably stand to have some of the internal things like Marshaller
documented.  But I think it does a decent job on the entry points and
externally visible things.

Fred and Fredrik, do your stuff!  You both need to proof this.
 2001-07-12 02:39:45 +00:00
Fred Drake 682d5f3cda Follow the recommended practices for keystroke representation; this 
improves internal consistency in the documentation.
 2001-07-12 02:09:51 +00:00
Fred Drake 07178d237a For \kbd, be more prescriptive regarding how keystrokes should be 
written.
 2001-07-12 02:08:29 +00:00
Fred Drake fa774872b8 Move the section on concrete numeric objects before the section on 
concrete sequence objects, since their API is simpler.

This is in response to a comment in SF bug #440037.
 2001-07-11 20:35:37 +00:00
Andrew M. Kuchling 7bf8277e98 Note addition of xmlrpclib 
Comment out descr-branch section
Update e-mail address
    (Time to begin writing this...)
 2001-07-11 18:54:26 +00:00
Fred Drake 9bbc933fcb Added information about the timeout parameter to the poll() method for 
polling objects.  This closes SF bug #439823.

Fixed a minor markup bug.
 2001-07-11 18:48:39 +00:00
Fred Drake d854831ddd Corrected the refcount information for PyList_SET_ITEM(). 2001-07-10 16:19:13 +00:00
Fred Drake bab2965c7c Document PyObject_New(), PyObject_NewVar(), PyObject_Init(), 
PyObject_InitVar(), PyObject_Del(), PyObject_NEW(),
PyObject_NEW_VAR(), and PyObject_DEL().

Add notes to PyMem_Malloc() and PyMem_New() about the memory buffers
not being initialized.

This fixes SF bug #439012.


Added explicit return value information for PyList_SetItem(),
PyDict_SetItem(), and PyDict_SetItemString().  Corrected return type
for PyList_SET_ITEM().

Fixed index entries in the descriptions of PyLong_AsLong() and
PyLong_AsUnignedLong().

This fixes the API manual portion of SF bug #440037.


Note that the headers properly declare everything as 'extern "C"' for
C++ users.

Document _Py_NoneStruct.

Added links to the Extending & Embedding manual for PyArg_ParseTuple()
and PyArg_ParseTupleAndKeywords().

Added note that PyArg_Parse() should not be used in new code.

Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
translation more difficult, as well as reading the English more
difficult for non-native speakers.
 2001-07-10 16:10:08 +00:00
Fred Drake 12060e5ed3 Added descriptions for some modules that previously did not have any 
information about them, based on comments from Jack Jansen.
 2001-07-10 14:19:45 +00:00
Fred Drake 67f193faab Add a little bit more about the XML migration plan. This still needs a lot 
of work, but mostly it needs time spent doing the work to make the
generated XML useful.
 2001-07-09 16:04:03 +00:00
Fred Drake 03e88da81b Add conversion information for the grammar production support (preliminary). 2001-07-09 15:00:42 +00:00
Thomas Wouters e30ac57038 Fix for SF bug #436525, reported by Greg Kochanski: 
The block/unblock thread macros are called 'Py_BLOCK_THREADS' and
'Py_UNBLOCK_THREADS', not 'Py_BEGIN_BLOCK_THREADS' and
'Py_BEGIN_UNBLOCK_THREADS'.
 2001-07-09 14:35:01 +00:00
Fred Drake 44835d8e7a Move & update a comment. 
Add support for the \ulink macro.
 2001-07-07 06:00:36 +00:00
Fred Drake de6dc1e11c Change the way notification mails are sent so people who respond to the 
update announcements do not get bounces from trying to send mail to my
laptop, which has an identity crisis due to constant relocation.
 2001-07-06 23:45:16 +00:00
Fred Drake 8e0c09da62 More reference count information. 2001-07-06 23:31:49 +00:00
Fred Drake cb4638a278 Change the grammar productions to use the new productionlist environment; 
this supports a hyperlinked version of the grammar that can make tracking
down details and definitions a little easier.
 2001-07-06 22:49:53 +00:00
Fred Drake b2d1006272 Update the description of how to start an interpreter and determine the 
installation prefix and exec_prefix for Windows.
 2001-07-06 22:46:52 +00:00
Fred Drake b4b64daa5e Add \ulink, grammar production markup. 2001-07-06 22:44:48 +00:00
Fred Drake 77602f2e32 Add support for \ulink and hyperlink grammars. 
do_cmd_verbatiminput():  Write out a text file containing the content of the
    input file with a .txt extension, and add a link to it at the bottom of
    the presentation.  This easier retrieval of example source code for
    copy & paste use.
 2001-07-06 22:43:02 +00:00
Fred Drake bde8d1c8af Revise a comment about styles I don't think LaTeX2HTML can generate, 
but which came from their default stylesheet.

Add styles for the new hyperlinked grammar productions.
 2001-07-06 22:37:36 +00:00
Fred Drake 432cef0d0b Add new material on some markup that will be checked in shortly. This 
includes some minor new inline markup and markup to generate hyperlinked
grammar productions.

Adopt a "style guide" document -- this beats writing our own and means
we'll have a chance at consistency, without having to make it all up
ourselves.
 2001-07-06 22:34:33 +00:00
Fred Drake 238858fc51 Packaged versions of the HTML format need to include any .txt files that 
were generated by the use of the productionlist environment or the
\verbatiminput macro.
 2001-07-06 22:28:47 +00:00
Fred Drake 7e79b9e1cc More names, yay! 2001-07-06 22:27:04 +00:00
Fred Drake 0a650d77d5 Add entries for recently defined markup. 2001-07-06 21:13:51 +00:00
Fred Drake dde993c15d Simplification to mirror a better conversion specification and more 
powerful latex2esis.py.
 2001-07-06 21:03:30 +00:00
Fred Drake b5fc0ab099 Allow optional arguments to LaTeX macros to span lines. This is legal in 
LaTeX and we have at least one occurance of that in the content, so this
script needs to support it as well.
 2001-07-06 21:01:19 +00:00
Fred Drake 907e76b620 Fix up a few style nits -- avoid "e.g." and "i.e." -- these make 
translation more difficult, as well as reading the English more
difficult for non-native speakers.
 2001-07-06 20:30:11 +00:00
Fred Drake ab1df4fe88 Fix up a few style nits -- avoid "e.g." and "i.e." -- these make 
translation more difficult, as well as reading the English more
difficult for non-native speakers.

Add an index entry for the Telnet protocol.

Always refer to the protocol as Telnet instead of telnet.
 2001-07-06 20:23:02 +00:00
Fred Drake 91f2f26d75 Fix up a few style nits -- avoid "e.g." and "i.e." -- these make 
translation more difficult, as well as reading the English more
difficult for non-native speakers.
 2001-07-06 19:28:48 +00:00
Fred Drake ed51494666 Fix up a few style nits -- avoid "e.g." and "i.e." -- these make 
translation more difficult, as well as reading the English more
difficult for non-native speakers.
 2001-07-06 17:28:39 +00:00
Fred Drake 45c23e61d8 Explain the exit code for the wait() method, including a reference to 
the os.W*() functions used to interpret the return value.

This fixes SF bug #429361.
 2001-07-06 17:17:12 +00:00
Fred Drake 15e33d828c Fix up a few style nits -- avoid "e.g." and "i.e." -- these make 
translation more difficult, as well as reading the English more
difficult for non-native speakers.
 2001-07-06 06:49:32 +00:00
Fred Drake bcd1df746d The fpectl module does not work on Windows, so remove Windows from the 
\platform statement.

Also fix a minor style consistency nit in an example.
 2001-07-05 21:17:08 +00:00
Fred Drake a939911345 Fix a markup error: do not omit a method's parameter list if it is 
empty.
 2001-07-05 21:14:03 +00:00
Fred Drake 25211f5724 Added more information on the differences between the htmllib and HTMLParser 
modules.
 2001-07-05 16:34:36 +00:00
Guido van Rossum 5fe2c139d5 List constraints on xrange() objects. 2001-07-05 15:27:19 +00:00
Guido van Rossum 3f56166b1a Rip out the fancy behaviors of xrange that nobody uses: repeat, slice, 
contains, tolist(), and the start/stop/step attributes.  This includes
removing the 4th ('repeat') argument to PyRange_New().
 2001-07-05 13:27:48 +00:00
Fred Drake 20006b2d51 Marked the parameters to Stats.print_*() as optional. 
This closes SF bug #438032.
 2001-07-02 21:22:39 +00:00
Fred Drake cb9be93955 Add another name. 2001-07-02 17:16:07 +00:00
Tim Peters 4efb6e9643 Turns out Neil didn't intend for *all* of his gen-branch work to get 
committed.

tokenize.py:  I like these changes, and have tested them extensively
without even realizing it, so I just updated the docstring and the docs.

tabnanny.py:  Also liked this, but did a little code fiddling.  I should
really rewrite this to *exploit* generators, but that's near the bottom
of my effort/benefit scale so doubt I'll get to it anytime soon (it
would be most useful as a non-trivial example of ideal use of generators;
but test_generators.py has already grown plenty of food-for-thought
examples).

inspect.py:  I'm sure Ping intended for this to continue running even
under 1.5.2, so I reverted this to the last pre-gen-branch version.  The
"bugfix" I checked in in-between was actually repairing a bug *introduced*
by the conversion to generators, so it's OK that the reverted version
doesn't reflect that checkin.
 2001-06-29 23:51:08 +00:00
Fred Drake 88e66254f9 Use the more conventional "self" as the name of the self parameter in an 
example.  It actually confused a reader.
 2001-06-29 17:50:57 +00:00
Fred Drake 0c209047ba Correct a markup error for an accented character. 
Reported by Milan Zamazal <pdm@zamazal.org>.
 2001-06-29 16:25:07 +00:00
Fred Drake 58c95391fa Removed some stray periods, and fix up a number of visible markup 
consistency errors (mostly omitted "()" at the end of function and
method names).

Reported by Milan Zamazal <pdm@zamazal.org>.
 2001-06-29 16:21:47 +00:00
Fred Drake 9c3c5e406d Two more names. 2001-06-29 15:42:20 +00:00
Fred Drake f29ca18df3 SourceForge bug #437041: 
Use a portable format in the example that creates a timestamp suitable for
use in email, also updating it and the footnote from RFC 822 to RFC 2822.
 2001-06-29 15:39:53 +00:00
Fred Drake 9f9bd6af78 Simplify an example based on comment from Thomas Holenstein <thomas@hex.ch>: 
Do not use an extra flag variable to test only once in one subsequent if
statement.
 2001-06-29 14:59:01 +00:00
Andrew M. Kuchling a43e70396e Add more items that need to be written about 2001-06-27 20:32:12 +00:00
Thomas Wouters 69940973db Remove duplicate ', ' in dbhash.open()'s argument list. 2001-06-27 13:49:59 +00:00
Barry Warsaw e9218a1a8e Remove the restriction on a mapping's .update() method. 2001-06-26 20:32:59 +00:00
Tim Peters 3e7b1a04a0 Teach the types module about generators. Thanks to James Althoff on the 
Iterators list for bringing it up!
 2001-06-25 19:46:25 +00:00
Fred Drake b037d33245 Updated link to zlib's home page. 2001-06-25 15:30:13 +00:00
Andrew M. Kuchling e7e03cd0cf Fix typo 2001-06-23 16:26:44 +00:00
Eric S. Raymond ff00fdae23 Correct erroneous description of precmd. 2001-06-23 14:42:43 +00:00
Fred Drake be9d10edbb Remove some bogus trailing whitespace. 2001-06-23 06:16:52 +00:00
Fred Drake 93852ef3c8 Fix minor markup nits. 2001-06-23 06:06:52 +00:00
Fred Drake deda9f3420 Use a named reference to another chapter instead of hard coding the 
chapter number.  This also makes the reference a hyperlink in the HTML
version.
 2001-06-23 06:06:21 +00:00
Fred Drake 2829f1cf99 Fix a very minor (but annoying when looking for things!) markup nit. 2001-06-23 05:27:20 +00:00
Fred Drake f5eae668a8 Add "yeild" to the list of keywords. 
Fix a very minor (but annoying when looking for things!) markup nit.
 2001-06-23 05:26:52 +00:00
Fred Drake 1ab1f71ec3 Consistently use semi-colons after the last property for each selector. 2001-06-23 04:53:43 +00:00
Fred Drake f015d9a5f6 Give the pattern used to pick out a source anchor a more specific pattern. 2001-06-23 04:35:09 +00:00
Fred Drake 5962eb0d89 Added several names. 2001-06-23 03:17:02 +00:00
Fred Drake 8058bfa6fc Contributed updates from Harald Hanche-Olsen, giving details of the branch 
cuts for the complex math functions.  Includes a brief description of
what branch cuts are.
 2001-06-23 03:16:29 +00:00
Fred Drake 6fe4660f61 Added support for our new \infinity and \plusminus macros, and the 
standard \textbar macro (not supported in many versions of LaTeX2HTML).

Added newline to error message.
 2001-06-23 03:13:30 +00:00
Fred Drake 5445e5e305 \infinity, 
\plusminus:  New macros to allow us to avoid math mode for these symbols.
 2001-06-23 03:11:45 +00:00
Fred Drake bfd80dd8c0 Miscellaneous code cleanups. 
Make sure we do not lose track of the build directory -- convert a user-
supplied directory to an absolute path.
 2001-06-23 03:06:01 +00:00
Fred Drake 1bf198e946 Remove an extra tab character. 2001-06-22 18:36:07 +00:00
Fred Drake 307cb05764 Re-organize a little, clean up some markup. 
Added some comments about sys.exit(), SystemExit, and preventing restricted
code from exiting the interpreter.

This closes SF bug #434743.
 2001-06-22 18:21:53 +00:00
Fred Drake f66cb5d0eb Corrected an error in the information on supporting weak references in 
extension types (the docs reflected a development version of the API).

This closes SF bug #435066.
 2001-06-22 17:20:29 +00:00
Fred Drake 9ca78ac57f Adjust to understand use of either single- or double-quotes to quote 
attribute values, and make the logic surrounding the platform
annotations just a little easier to read.  Also make the platform
notes appear in the generated page; they were supposed to, but did not.
 2001-06-22 17:11:30 +00:00
Fred Drake aff8837740 Add the new texinputs/license.tex to the shared dependencies. 2001-06-22 17:07:02 +00:00
Fred Drake 93438bf0a2 Fix & clean up the information about building Python with large file support 
for Linux.

This closes SF bug #434975.
 2001-06-22 16:01:20 +00:00
Fred Drake 490d34dbad Move license information to a less annoying location in the document. 
Add documentation for PyErr_SetFromErrnoWithFilename().
 2001-06-20 21:39:12 +00:00
Fred Drake d5df09cfb6 Update to include the license information in a less annoying place. 2001-06-20 21:37:34 +00:00
Fred Drake 852f7951a2 Separate the copyright statements and license text; include some new 
comments regarding the history of Python licensing from Guido.
 2001-06-20 21:34:35 +00:00
Fred Drake f911a84d5a Separate the version number and release status into two separate values. 2001-06-20 21:33:13 +00:00
Fred Drake dce975c820 Update to use the newly separated values $PACKAGE_VERSION and $RELEASE_INFO. 
Normalize all HTML attributes to be written as name="value" instead of
name='value'.
 2001-06-20 21:31:36 +00:00
Fred Drake f1927a6d80 Added support for new \setreleaseinfo macro. 
Normalize all generated HTML so that attribute names come out as
name="value" instead of name='value'.
Changed the target of RFC links to point to the hypertext RFCs at
www.faqs.org instead of the plain text RFCs at www.ietf.org.
 2001-06-20 21:29:30 +00:00
Fred Drake c65218e1fd Add a little more support for describing version information. This 
is not pretty, but does what is needed.
 2001-06-20 21:17:09 +00:00
Barry Warsaw 6016e39250 Document the new encodestring() and decodestring() functions. Also, 
add some description of what the quotetabs argument does for the
encode*() functions.  Finally, add a "see also" pointing to the base64
module.
 2001-06-19 19:44:42 +00:00
Fred Drake 66eed24415 Add some information on the use of \verbatiminput to display sources from 
an external file.
 2001-06-18 14:59:58 +00:00
Tim Peters fa9e273442 Clarification in the fp appendix suggested on c.l.py by Michael Chermside. 
Also replaced a *star* style emphasis in the Representation Error section
with an \emph{} thingie.
 2001-06-17 21:57:17 +00:00
Martin v. Löwis 918f2c722a Document that filter is added in 2.2. 2001-06-16 08:14:04 +00:00
Fred Drake 57e52ef076 Implement the \verbatiminput LaTeX macro; this contains more magic than 
it should, but only enough that LaTeX2HTML doesn't bite us.
 2001-06-15 21:31:57 +00:00
Fred Drake 54d10fd2cd Add a version annotation for the Q and q format codes. 2001-06-15 14:13:07 +00:00
Fred Drake 8fcd4b5ab3 Fix an improperly placed comma. 2001-06-14 13:57:16 +00:00
Fred Drake 66a0a0a9b6 Make the option processing more robust. 
Add a -F option similar to "cvs commit -F <file>".
Add a -t option to allow specifying the prefix to the directory into which
the docs should be unpacked (useful when I start trying out new styles for
the presentation).
 2001-06-12 13:31:37 +00:00
Fred Drake 4a6c5c568f Fixed reference to table notes for {}.keys() and {}.items() -- these 
references did not get updated when the notes were renumbered in a
previous update.

This fixes SF bug #432208.
 2001-06-12 03:31:56 +00:00
Tim Peters 7a3bfc3a47 Added q/Q standard (x-platform 8-byte ints) mode in struct module. 
This completes the q/Q project.

longobject.c _PyLong_AsByteArray:  The original code had a gross bug:
the most-significant Python digit doesn't necessarily have SHIFT
significant bits, and you really need to count how many copies of the sign
bit it has else spurious overflow errors result.

test_struct.py:  This now does exhaustive std q/Q testing at, and on both
sides of, all relevant power-of-2 boundaries, both positive and negative.

NEWS:  Added brief dict news while I was at it.
 2001-06-12 01:22:22 +00:00
Fred Drake 0b9bc20e66 Add the appropriate availability annotations for the popen*() family of 
functions -- these are not available on traditional Mac OS platforms.

Corrected the version annotations for the spawn*() functions and related
constants; these were added in Python 1.6, not 1.5.2.
 2001-06-11 18:25:34 +00:00
Fred Drake 046f4d810d Fixed parameter order for os.popen2(), os.popen3(), and os.popen(4). Added 
a reference to these functions and popen() from the "Process Management"
section.

Based on a suggestion from comp.lang.python.
 2001-06-11 15:21:48 +00:00
Fred Drake c115835457 Fix recent changes so that this section will format again. 2001-06-11 14:55:01 +00:00
Tim Peters 7b9542a3f7 Initial support for 'q' and 'Q' struct format codes: for now, only in 
native mode, and only when config #defines HAVE_LONG_LONG.  Standard mode
will eventually treat them as 8-byte ints across all platforms, but that
likely requires a new set of routines in longobject.c first (while
sizeof(long) >= 4 is guaranteed by C, there's nothing in C we can rely
on x-platform to hold 8 bytes of int, so we'll have to roll our own;
I'm thinking of a simple pair of conversion functions, Python long
to/from sized vector of unsigned bytes; that may be useful for GMP
conversions too; std q/Q would call them with size fixed at 8).

test_struct.py:  In addition to adding some native-mode 'q' and 'Q' tests,
got rid of unused code, and repaired a non-portable assumption about
native sizeof(short) (it isn't 2 on some Cray boxes).

libstruct.tex:  In addition to adding a bit of 'q'/'Q' docs (more needed
later), removed an erroneous footnote about 'I' behavior.
 2001-06-10 23:40:19 +00:00
Fred Drake 7bc50714fe Fix the attributions for the new floating point text. 2001-06-08 17:09:01 +00:00
Fred Drake 8c27d99941 Added credits in the right places. 2001-06-08 16:28:53 +00:00
Fred Drake 417d667dd9 Text from Tim & Guido discussing floating point arithmetic and what users 
need to understand about the binary & decimal fp, so that representation
weirdness is documented somewhere.  This makes it easier to repond to "bug"
reports caused by user confusion & ignorance of the issues.

This closes SF patch #426208.
 2001-06-08 16:24:58 +00:00
Skip Montanaro 1dc98c44fe add warning about situation where code may be executed twice, once when 
module is __main__ and once when module is imported.
 2001-06-08 14:40:28 +00:00
Fred Drake 62f9d7c021 In the section on extending the profiler, add some additional discussion 
about setting up the dispatch table, and update the OldProfile and
HotProfile classes to the current implementations, showing the adjusted
construction for the dispatch table.
 2001-06-08 05:04:19 +00:00
Martin v. Löwis e2ccb89513 Document filter. 2001-06-07 19:01:24 +00:00
Fred Drake 2a9bda9223 Typo: "descrition" --> "description" 
Add reference to the documentation for the Python documentation markup.

Fixed up a couple of descriptions.

This closes SF bug #430627.
 2001-06-06 16:02:47 +00:00
Fred Drake 9ccc0df52f Add references to the documentation for the Python documentation markup. 
Suggested by the comments in SF bug #430627.
 2001-06-06 15:59:04 +00:00
Martin v. Löwis e24fef0dd2 Fix bug #422702: Make flag argument to open optional, and document it that way. 2001-06-05 05:33:19 +00:00
Fred Drake 88382696f4 Update a "Programmer's note" about lambda forms and scoping to reflect 
the availability of nested scoping in Python 2.1 and 2.2.
 2001-06-05 02:17:02 +00:00
Skip Montanaro b9d973dac5 is -> if in rename description 2001-06-04 15:31:17 +00:00
Fred Drake 00d0cb6ec3 Explained more differences between PyList_SetItem() and PyList_SET_ITEM(). 
In particular, the affect on existing list content was not sufficiently
explained.

This closes SF bug #429554.
 2001-06-03 03:12:57 +00:00
Fred Drake 81e142b907 Document os.getenv(). 
This closes SF bug #429059.
 2001-05-31 20:27:46 +00:00
Fred Drake c19f39272e Some general cleanup of the threading module documentation, including 
fixing the reference to Thread.getDeamon() (should be isDaemon()).

This closes SF bug #429070.
 2001-05-31 20:24:07 +00:00
Fred Drake 6cba3d0e64 Added entry for HTMLParser documentation. 2001-05-30 04:59:50 +00:00
Fred Drake 3b755d43ac Michel Pelletier <michel@digicool.com>: 
Documentation for the HTMLParser module, with small changes by FLD.
 2001-05-30 04:59:00 +00:00
Fred Drake 9a374186fc New solution to the "Someone stuck a colon in that filename!" problem: 
Allow colons in the labels used for internal references, but do not
expose them when generating filename.
 2001-05-29 19:53:46 +00:00
Fred Drake 96a2a80065 Users of PySequence_GET_FAST() should get the length of the sequence using 
PySequence_Size(), not PyObject_Size(): the later considers the mapping
methods as well as the sequence methods, which is not needed here.  Either
should be equally fast in this case, but PySequence_Size() offers a better
conceptual match.
 2001-05-29 18:51:41 +00:00
Fred Drake 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
Fred Drake 964c074a62 Hack to make this play nicer with *old* versions of Python: os.path.abspath() 
was not available in Python 1.5.1.  (Yes, a user actually tried to use this
with that version of Python!)
 2001-05-29 16:10:07 +00:00
Fred Drake 597bc1d46f Bring the notes on the relationship between __cmp__(), __eq__(), and 
__hash__() up to date (re: use of objects which define these methods
as dictionary keys).

This closes SF bug #427698.
 2001-05-29 16:02:35 +00:00
Fred Drake b9879e1020 Fix typo reported in SF bug #427783. 2001-05-29 15:44:27 +00:00
Fred Drake 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
Fred Drake b2625eb10e Removed information on the old third parameter to _PyTuple_Resize(). 
Added information on PyIter_Check(), PyIter_Next(),
PyObject_Unicode(), PyString_AsDecodedObject(),
PyString_AsEncodedObject(), and PyThreadState_GetDict().
 2001-05-29 15:34:06 +00:00
Fred Drake 404ac97207 If the input line does not contain enough fields, raise a meaningful 
error.
 2001-05-29 15:25:51 +00:00
Fred Drake fac312ff88 Do not start API descriptions with "Does the same, but ..." -- actually 
state *which* other function the current one is like, even if the
descriptions are adjacent.

Revise the _PyTuple_Resize() description to reflect the removal of the
third parameter.
 2001-05-29 15:13:00 +00:00
Fred Drake 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
Fred Drake 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
Fred Drake 98cfab6523 One more update related to the new get() and setdefault() methods on the 
Message object.
 2001-05-22 22:00:40 +00:00
Fred Drake 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
Fred Drake 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
Tim Peters bd695a716d Changed all the examples with ugly platform-dependent float output to use 
numbers that display nicely after repr().  From much doctest experience
with the same trick, I believe people find examples with simple fractions
easier to understand too:  they can usually check the results in their
head, and so feel confident about what they're seeing.  Not even I get a
warm feeling from a result that looks like 70330.345024097141 ...
 2001-05-22 06:54:14 +00:00
Fred Drake 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
Fred Drake 8b0b8409ae Update output to reflect additional precision produced by the repr() of 
floating point numbers in an interactive example.


Added comment to help explain control flow in the example code showing
how to check if a number is prime.

This closes SF bugs 419434 and 424552.
 2001-05-21 16:55:39 +00:00
Fred Drake 24e621918b Add documentation for Py_Main() and PyThreadState_GetDict(). 2001-05-21 15:56:55 +00:00
Fred Drake fc43d00c17 Typo: "that" --> "than" 
This closes SF bug #425320.
 2001-05-21 15:03:35 +00:00
Fred Drake 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
Fred Drake 09daff4596 Get Aahz listed correctly using his legal/professional name. 2001-05-20 05:29:01 +00:00
Andrew M. Kuchling 3b923fcff5 Add another item 2001-05-19 19:35:46 +00:00
Fred Drake 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
Marc-André Lemburg 2d9204199f This patch changes the way the string .encode() method works slightly 
and introduces a new method .decode().

The major change is that strg.encode() will no longer try to convert
Unicode returns from the codec into a string, but instead pass along
the Unicode object as-is. The same is now true for all other codec
return types. The underlying C APIs were changed accordingly.

Note that even though this does have the potential of breaking
existing code, the chances are low since conversion from Unicode
previously took place using the default encoding which is normally
set to ASCII rendering this auto-conversion mechanism useless for
most Unicode encodings.

The good news is that you can now use .encode() and .decode() with
much greater ease and that the door was opened for better accessibility
of the builtin codecs.

As demonstration of the new feature, the patch includes a few new
codecs which allow string to string encoding and decoding (rot13,
hex, zip, uu, base64).

Written by Marc-Andre Lemburg. Copyright assigned to the PSF.
 2001-05-15 12:00:02 +00:00
Fred Drake b3384d3555 Make sure we include all of Python's numeric types in the data model 
description, so that the introduction of complex is not a surprise.

This closes SF bug #423429.
 2001-05-14 16:04:22 +00:00
Fred Drake 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
Fred Drake 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
Fred Drake 47852467f5 Markup adjustments to avoid getting junk in the index. 2001-05-11 15:46:45 +00:00
Fred Drake 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
Fred Drake 9f2376de7a Document the new classdesc* environment, and the previously undocumented 
excclassdesc environment.
 2001-05-11 01:01:12 +00:00
Fred Drake 06a01e84b9 Define a new environment, classdesc*, which can be used to document a 
class without providing any information about the constructor.  This
should be used for classes which only exist to act as containers rather
than as factories for instances.
 2001-05-11 01:00:30 +00:00
Fred Drake 986badae1e Write a better synopsis for the Scrap module, and provide a link to 
useful documentation on the Scrap Manager.
 2001-05-10 22:37:38 +00:00
Fred Drake 0eeca6342f Actually include a synopsis line for the ColorPicker module. 2001-05-10 22:36:13 +00:00
Fred Drake e7ec1efe50 Fix typo in weakref.proxy() documentation. 
This closes SF bug #423087.
 2001-05-10 17:22:17 +00:00
Fred Drake 791c351b3d Update example to no longer use the FCNTL module. 2001-05-10 15:57:17 +00:00
Fred Drake 7c116d7acb Fix typo reported by David Goodger. This closes SF patch #422383. 2001-05-10 15:09:36 +00:00
Fred Drake 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
Fred Drake d0de57cfbb Update the fcntl module documentation. 2001-05-09 21:09:57 +00:00
Fred Drake 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
Fred Drake b8ac0096b2 Fix the operator precedence table: exponentiation binds tighter than 
negation.

This closes SF bug #421999.
 2001-05-09 16:51:49 +00:00
Fred Drake 251ebe7d30 Remove items that have been done or are being tracked in the SourceForge 
bug tracker.
 2001-05-09 16:43:47 +00:00
Fred Drake 283b352d48 Update the directory names to match changes at SourceForge. 2001-05-09 16:33:34 +00:00
Fred Drake 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
Fred Drake caa79a9ee4 Minor adjustments to HTML for the module synopsis tables. 2001-05-09 15:32:14 +00:00
Fred Drake af922187ae Job.build_html(): Be more robust in ensuring about.html exists; copying 
the right HTML file to the name about.html is needed even if the
    --numeric option was not given -- some other name may have been
    assigned due to some non-determinism in the algorithm use to perform
    name allocation.  ;-(

This closes the "About..." portion of SF bug #420216.
 2001-05-09 04:03:16 +00:00
Fred Drake 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
Fred Drake 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
Fred Drake 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
Fred Drake a8e0827614 Hmm... better add a version annotation for the Iterator Protocol section. 2001-05-07 17:47:07 +00:00
Fred Drake dbcaeda79a Added documentation for PyIter_Check() and PyIter_Next(). 
Wrapped a long line.
 2001-05-07 17:42:18 +00:00
Andrew M. Kuchling a8defaae04 Skeletal version; I'm checking this in now so I can keep a list of changes, 
but don't plan on actually writing any text until, ooh, say, July or
   thereabouts.
 2001-05-05 16:37:29 +00:00
Fred Drake 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
Fred Drake 9cfe1824c2 Add documentation for the StopIteration exception. 2001-05-03 04:30:45 +00:00
Fred Drake 287c4cb43a State that Mailbox objects are iterator objects. 2001-05-02 20:22:12 +00:00
Fred Drake eacdec6b38 Update the filter() and list() descriptions to include information about 
the support for containers and iteration.
 2001-05-02 20:19:19 +00:00
Fred Drake 93656e76f9 Added section describing the iterator protocol. 2001-05-02 20:18:03 +00:00
Marc-André Lemburg 6f15e5796e Added new parser markers 'et' and 'et#' which do not recode string 
objects but instead assume that they use the requested encoding.

This is needed on Windows to enable opening files by passing in
Unicode file names.
 2001-05-02 17:16:16 +00:00
Fred Drake 9188b2194a Correct two floating-point representations printed by the interpreter in 
interactive examples.  Error noted by Dinu Gherman.
 2001-04-25 21:03:20 +00:00
Marc-André Lemburg 8155e0e541 This patch originated from an idea by Martin v. Loewis who submitted a 
patch for sharing single character Unicode objects.

Martin's patch had to be reworked in a number of ways to take Unicode
resizing into consideration as well. Here's what the updated patch
implements:

* Single character Unicode strings in the Latin-1 range are shared
  (not only ASCII chars as in Martin's original patch).

* The ASCII and Latin-1 codecs make use of this optimization,
  providing a noticable speedup for single character strings. Most
  Unicode methods can use the optimization as well (by virtue
  of using PyUnicode_FromUnicode()).

* Some code cleanup was done (replacing memcpy with Py_UNICODE_COPY)

* The PyUnicode_Resize() can now also handle the case of resizing
  unicode_empty which previously resulted in an error.

* Modified the internal API _PyUnicode_Resize() and
  the public PyUnicode_Resize() API to handle references to
  shared objects correctly. The _PyUnicode_Resize() signature
  changed due to this.

* Callers of PyUnicode_FromUnicode() may now only modify the Unicode
  object contents of the returned object in case they called the API
  with NULL as content template.

Note that even though this patch passes the regression tests, there
may still be subtle bugs in the sharing code.
 2001-04-23 14:44:21 +00:00
Guido van Rossum 8b3d6ca3df At the suggestion of Peter Funk, document 'key in dict' and 'key not 
in dict' after has_key(), with a \versionadded{2.2} note.
 2001-04-23 13:22:59 +00:00
Fred Drake 34b48e844e Update publish-to-SourceForge scripts to automatically determine if the 
branch is the head (development) branch or a maintenance brach, and use
the appropriate target directory for each.
 2001-04-22 06:20:31 +00:00
Fred Drake 82f93c693d Only document <file>.xreadlines() once; added version annotation. 
This closes SF bug #417943.
 2001-04-22 01:56:51 +00:00
Fred Drake e99b97e58a encode(): Handle Latin-1 input characters better. 2001-04-21 06:01:53 +00:00
Fred Drake bda05564de Add support for <memberline/> (needs markup improvement!). 
Update <versionadded/> to recent addition of optional explanatory text;
make the explanation text take the same attribute name for both
<versionadded/> and <versionchanged/>.
 2001-04-21 06:00:51 +00:00
Fred Drake 4cacec5393 Fix a number of minor markup errors. 2001-04-21 05:56:06 +00:00
Fred Drake 056a71da76 The (fairly recent) \textasciicircum is not supported by LaTeX2HTML; add 
support for it here.
 2001-04-21 05:48:07 +00:00
Guido van Rossum 0dbb4fba4c Implement, test and document "key in dict" and "key not in dict". 
I know some people don't like this -- if it's really controversial,
I'll take it out again.  (If it's only Alex Martelli who doesn't like
it, that doesn't count as "real controversial" though. :-)

That's why this is a separate checkin from the iterators stuff I'm
about to check in next.
 2001-04-20 16:50:40 +00:00