Commit Graph

6584 Commits

Author SHA1 Message Date
Fred Drake e143bbb610 fix documentation for ContentHandler.ignorableWhitespace()
(closes SF bug #881707)
2004-05-06 03:47:48 +00:00
Fred Drake 56fcc233d3 markup adjustments 2004-05-06 02:55:35 +00:00
Martin v. Löwis 456ab1d271 Swap public and system ID in start_doctype_decl. Fixes #780300. 2004-05-06 01:54:36 +00:00
Martin v. Löwis f1f0560832 Patch #940026: Explain "in" when it is first used.
Backported to 2.3.
2004-05-06 01:35:45 +00:00
Andrew M. Kuchling 99872c1342 [Bug #810879] Document that copyfile() can fail if you don't have permissions; also, fix a double negative. 2004-05-05 17:21:51 +00:00
Brett Cannon 0fefc140aa Fix small grammatical mistake. 2004-05-05 16:49:11 +00:00
Fred Drake 8aa8c84d18 add an index entry for __getnewargs__() 2004-05-05 04:56:06 +00:00
Fred Drake 0de77d1d6e - note that __getinitargs__() is only for old-style classes
- describe __getnewargs__()
(closes SF bug #873246)
2004-05-05 04:54:37 +00:00
Fred Drake 04d92c37f2 Remove list of pickle protocol names used by the copy module; there
are enough subtleties to pickling that we don't want misunderstanding
to spread because we don't provide all the information twice.  The
reference to the pickle module for information will have to suffice;
at least only one portion of the docs will be out of date.  ;-(
2004-05-05 04:24:30 +00:00
Fred Drake cee8879a7d note that the error code for socket.gaierror will be one of the EAI_*
constants
(closes SF bug #837929)
2004-05-05 04:18:11 +00:00
Greg Ward 4fe97ca4ce SF #814606: merge from release23-maint branch: clarify/cleanup
mixer docs; trim \platform{}, add \versionadded{}.
2004-05-05 01:36:16 +00:00
Nicholas Bastin e9c2ecfb96 Removed 'U' from the documentation for Py_BuildValue to bring it in line
with the elimination of 'U' in modsupport.c on 2000/04/28 (replaced
with 'u' and 'u#' per fdrake's comments).
2004-05-04 19:25:56 +00:00
Phillip J. Eby 5068c873e6 Document readline module functions added in Python 2.3. See:
http://mail.python.org/pipermail/python-dev/2003-September/037922.html

for background.  It appears I forgot to ever submit a bug report or patch.
2004-05-04 19:20:22 +00:00
Raymond Hettinger d7911a3317 Minor documentation nits. 2004-05-01 08:31:36 +00:00
Raymond Hettinger f5f9a370d4 Add an example application to the docs. 2004-04-30 22:52:50 +00:00
Fred Drake 6fbf703fa2 the headers in an HTTP request are HTTP headers, not MIME headers 2004-04-29 02:47:38 +00:00
Fred Drake ceeb1918a1 remove out-of-date count of the functions in winsound 2004-04-28 03:57:47 +00:00
Fred Drake 6d4c7b05bb fix typo reported in a long-buried email 2004-04-28 03:16:49 +00:00
Raymond Hettinger 46a16f297f SF bug #940579: section 5.10: 'not' returns boolean, not int 2004-04-23 17:11:47 +00:00
Thomas Heller 1328b52c6f Two new public API functions, Py_IncRef and Py_DecRef. Useful for
dynamic embedders of Python.
2004-04-22 17:23:49 +00:00
Raymond Hettinger e5fced781b SF bug #936827: PyNumber_And() 's description
Fix typo.
2004-04-17 11:57:40 +00:00
Fred Drake 0ed663443e really scream out that people should use the file objects instead of
file descriptor operations for normal applications
2004-04-16 15:20:01 +00:00
Skip Montanaro 10659f2540 bring description of optional and keyword args for DictReader and DictWriter
classes into line with the actual code.  I didn't see any obvious examples
of latex formatting for *args and **kwds so I just guessed.
2004-04-16 03:21:01 +00:00
Fred Drake 8efc74d35e remove bogus markup that caused the docs to be wrong 2004-04-15 06:18:48 +00:00
Fred Drake 6b3b046ab0 fix up some markup 2004-04-09 18:26:40 +00:00
Fred Drake 94ffbb71a8 give rational filenames to some of the generated HTML 2004-04-08 19:44:31 +00:00
Fred Drake 4cc425a0a3 switch to PNG navigation icons by default 2004-04-08 18:51:39 +00:00
Fred Drake 4f580e8394 include both the GIF and PNG icons in the HTML package 2004-04-08 18:50:51 +00:00
Fred Drake 899072ab71 avoid stripping space after indexing macros 2004-04-08 15:30:12 +00:00
Neal Norwitz ba813e2089 #928751, fix typos in socket doc 2004-04-03 18:02:37 +00:00
Fred Drake 8effa01931 fix typo that wasn't properly fixed in revision 1.144 2004-04-01 04:30:29 +00:00
Fred Drake 862b46bbc1 add a heavy box around warning notices to make them really stand out in the
PDF and PostScript versions of the docs (the CSS already does this for HTML)
2004-03-31 08:08:34 +00:00
Fred Drake 90756c2da7 add missing and forthcoming releases 2004-03-31 08:04:46 +00:00
Fred Drake 34c43202eb Emphasize the requirement that Python.h be included first more strongly.
Closes SF bug #837228; backporting for Python 2.3.4.
2004-03-31 07:45:46 +00:00
Fred Drake 203b10c75a added scripts to the list of files automatically included in the
distribution (see SF bug #796042)
2004-03-31 01:50:37 +00:00
Andrew M. Kuchling aeaec8d4aa fix typo 2004-03-29 01:19:54 +00:00
Raymond Hettinger f13c024002 Insert missing pronoun 2004-03-28 22:44:09 +00:00
Skip Montanaro dbb407808a - add entry for complex number
- fix a couple typos
- refine definitions for "interpreted" and "coercion" based upon updates on
  the python glossary wiki
2004-03-27 18:23:11 +00:00
Fred Drake 8123ff6bca remove out-of-date warning 2004-03-26 17:11:10 +00:00
Raymond Hettinger 707483fdef Update timeit example to reflect current performance. 2004-03-26 07:56:23 +00:00
Fred Drake 504ca68e20 Note that reading from a socket may not always return all of the
remaining content of a stream when expected to do so.
Closes SF bug #725265.  Should be backported to Python 2.3.x.
2004-03-25 16:51:12 +00:00
Fred Drake 267b062432 - make sure the methods minidom adds to the basic DOM are attributed
to Node objects in the index (closes SF bug #832251)
- fix a variety of markup nits

Someone should backport this patch to Python 2.3.x.
2004-03-25 16:39:46 +00:00
Fred Drake ad62202a5e include the right index sources 2004-03-25 16:35:10 +00:00
Fred Drake 73789bc8f5 remove duplicate use of the meta-data label 2004-03-25 16:33:29 +00:00
Fred Drake 2f00c5453e fix typo 2004-03-25 16:14:17 +00:00
Fred Drake f39c3c7a6b note that distutils API docs are included in "Distributing Python
Modules"
2004-03-25 16:12:08 +00:00
Fred Drake d0c3b26bd0 improve the very-high-level API docs (contributed by Jeff Epler)
Closes SF patch #798638.
2004-03-25 15:44:56 +00:00
Fred Drake 85309512ec Remove note that PyErr_SetInterrupt() is obsolete; add comment about the
fact that it was marked obsolete but is still needed.
Closes SF bug #919299.  Someone else should backport this to Python 2.3.
2004-03-25 14:25:28 +00:00
Raymond Hettinger 5232f50b19 SF bug: #921927: Fixed a typo/thinko spelling "parameter" as "paramter" 2004-03-25 08:51:36 +00:00
Nicholas Bastin c69ebe8d50 Enable the profiling of C functions (builtins and extensions) 2004-03-24 21:57:10 +00:00
Fred Drake fee6f33e08 more markup nits 2004-03-23 21:40:07 +00:00
Fred Drake e05c3e0fbb fix markup nits 2004-03-23 20:30:59 +00:00
Fred Drake 4ac6c6afc3 add the distutils modules to the global modules list 2004-03-23 19:26:54 +00:00
Fred Drake 6356fff2cb give the document indexes 2004-03-23 19:02:38 +00:00
Fred Drake 630e5bd2f7 - use recommended Python style in examples (no spaces around "=" for
keyword args)
- format multi-line calls to distutils.core.setup() consistently, and
  in line with general practice (one keyword arg per line,
  comma/newline after the last
- fix a few typos
2004-03-23 18:54:12 +00:00
Nicholas Bastin 824b1b2da8 Added command line options for profile.py - one for stats output file
and one for sort order when using stdout.  Uses optparse.
2004-03-23 18:44:39 +00:00
Fred Drake 6fca7cc783 merge Anthony Baxter's distutils API reference into the package
author's documentation
2004-03-23 18:43:03 +00:00
Fred Drake 211a2eb784 convert from a howto to a manual 2004-03-22 21:44:43 +00:00
Nicholas Bastin 1eb4bfc657 Added global runctx function to profile to fix SF Bug #716587 2004-03-22 20:12:56 +00:00
Andrew M. Kuchling cbddabfd85 Remove 'now' 2004-03-21 22:12:45 +00:00
Nicholas Bastin 07973dab97 Modified string.split documentation to reflect behaviour of splitting emtpy string. Closes SF bug #811604 2004-03-21 16:59:59 +00:00
Skip Montanaro 20a8336ff7 concrete example of why retaining old objects is good 2004-03-21 16:05:30 +00:00
Brett Cannon 8b6cc2e7f2 Removed extra period from \versionchanged entry; macro adds period
automatically.
2004-03-21 14:10:18 +00:00
Brett Cannon 508c57d544 Clarify docs on where .pth files can exist. 2004-03-20 21:41:28 +00:00
Raymond Hettinger fe703e0650 SF bug #918371: hasattr()'s return type
Replace 1 and 0 with True and False.
2004-03-20 18:25:31 +00:00
Tim Peters d4079e1fc2 Update copyright years, and change copyright.tex to use the same spelling
as license.tex (SF patch 795531 complained about the spelling discrepancy,
although this "repairs" that flaw in a different way than the patch).
2004-03-20 17:24:51 +00:00
Fred Drake 9de0a2ba9d fix two typos that turned text into markup 2004-03-20 08:13:32 +00:00
Skip Montanaro 8e6ad6fbe9 Expand on the semantics of reload(). Closes #919099. 2004-03-19 15:20:16 +00:00
Hye-Shik Chang 5c5316f111 Add a new unicode codec: ptcp154 (Kazakh) 2004-03-19 08:06:07 +00:00
Raymond Hettinger ade08ea8a8 Add news entries for the dictionary optimizations. 2004-03-18 09:48:12 +00:00
Brett Cannon d1de45f549 Fix capitalization of title for subsection 2. 2004-03-18 07:37:15 +00:00
Brett Cannon 65d63424b4 Minor grammatical fixes. 2004-03-18 01:38:11 +00:00
Brett Cannon 9b976e6636 Extremely minor typo fixed. 2004-03-18 00:49:01 +00:00
Skip Montanaro bdda9f389a The example files need to be opened with the "b" flag. 2004-03-17 01:24:17 +00:00
Raymond Hettinger 49f9bd15ff SF feature request #686323: Minor array module enhancements
array.extend() now accepts iterable arguments implements as a series
of appends.  Besides being a user convenience and matching the behavior
for lists, this the saves memory and cycles that would be used to
create a temporary array object.
2004-03-14 05:43:59 +00:00
Raymond Hettinger c1e4f9dd92 Use a new macro, PySequence_Fast_ITEMS to factor out code common to
three recent optimizations.  Aside from reducing code volume, it
increases readability.
2004-03-12 08:04:00 +00:00
Hye-Shik Chang 9168c70438 SF Patch #912462: Relocate \end tag to the right place.
(Submitted by George Yoshida)
2004-03-09 05:53:15 +00:00
Raymond Hettinger b7d05db0be Optimize tuple_slice() and make further improvements to list_slice()
and list.extend().  Factoring the inner loops to remove the constant
structure references and fixed offsets gives speedups ranging from
20% to 30%.
2004-03-08 07:25:05 +00:00
Raymond Hettinger dd80f76265 SF patch #910929: Optimize list comprehensions
Add a new opcode, LIST_APPEND, and apply it to the code generation for
list comprehensions.  Reduces the per-loop overhead by about a third.
2004-03-07 07:31:06 +00:00
Raymond Hettinger 31017aed36 SF #904720: dict.update should take a 2-tuple sequence like dict.__init_
(Championed by Bob Ippolito.)

The update() method for mappings now accepts all the same argument forms
as the dict() constructor.  This includes item lists and/or keyword
arguments.
2004-03-04 08:25:44 +00:00
Raymond Hettinger 35c62e58c5 Added license notices that are required to be included in the
documentation as well as the source code.
2004-03-03 08:27:25 +00:00
Brett Cannon d1080a3418 Have strftime() check its time tuple argument to make sure the tuple's values
are within proper boundaries as specified in the docs.

This can break possible code (datetime module needed changing, for instance)
that uses 0 for values that need to be greater 1 or greater (month, day, and
day of year).

Fixes bug #897625.
2004-03-02 04:38:10 +00:00
Raymond Hettinger 0a4977c2f3 Replace left(), right(), and __reversed__() with the more general purpose
__getitem__() and __setitem__().

Simplifies the API, reduces the code size, adds flexibility, and makes
deques work with bisect.bisect(), random.shuffle(), and random.sample().
2004-03-01 23:16:22 +00:00
Raymond Hettinger 738ec90ca1 Improvements to collections.deque():
* Add doctests for the examples in the library reference.
* Add two methods, left() and right(), modeled after deques in C++ STL.
* Apply the new method to asynchat.py.
* Add comparison operators to make deques more substitutable for lists.
* Replace the LookupErrors with IndexErrors to more closely match lists.
2004-02-29 02:15:56 +00:00
Neal Norwitz fb0521f153 Use versionadded for new features 2004-02-28 16:00:23 +00:00
Neal Norwitz 3e0877ef88 Add version changed/added to doc 2004-02-28 15:19:33 +00:00
Fred Drake 59e02c110d fix typo in reference to RFC 3464 DSN MIME type 2004-02-24 20:58:10 +00:00
Fred Drake f0ae4272b4 fix English usage error reported by Ken Fuchs 2004-02-24 16:13:36 +00:00
Fred Drake 781380c1f8 - "Mac OS" should always include the space
- comment out documentation for a non-existant feature (--spec-file)
  that the comments indicate isn't clearly needed
- lots of minor markup adjustments to get a more consistent
  presentation
2004-02-19 23:17:46 +00:00
Fred Drake 2a1bc50663 - according to Apple's publication style guide, yes, "Mac people" use
the term Installer (always capitalized, however)
- generalize the text about the term "installer" in a fairly
  reasonable way
2004-02-19 23:03:29 +00:00
Fred Drake a9ee0da8f3 use API documentation style for the descriptions of the additional
functions made available in the post-installation script run by the
Windows installer
2004-02-19 22:28:15 +00:00
Fred Drake c54d9256fb minor markup improvements 2004-02-19 22:16:05 +00:00
David Ascher e2b4b32025 Implementation of patch 869468
Allow the user to create Tkinter.Tcl objects which are
just like Tkinter.Tk objects except that they do not
initialize Tk. This is useful in circumstances where the
script is being run on machines that do not have an X
server running -- in those cases, Tk initialization fails,
even if no window is ever created.

Includes documentation change and tests.

Tested on Linux, Solaris and Windows.

Reviewed by Martin von Loewis.
2004-02-18 05:59:53 +00:00
Raymond Hettinger 79b5cf1129 Mention the optimization of list.extend(). 2004-02-17 10:46:32 +00:00
Fred Drake 70a30e8c94 markup correction 2004-02-17 04:17:36 +00:00
Martin v. Löwis d3f4a1a00a Patch #893566: Document that tp_dealloc may be called from any thread. 2004-02-15 21:01:17 +00:00
Raymond Hettinger ab517d2eac Fine tune the speed/space trade-off for overallocating small lists.
The Py2.3 approach overallocated small lists by up to 8 elements.
The last checkin would limited this to one but slowed down (by 20 to 30%)
the creation of small lists between 3 to 8 elements.

This tune-up balances the two, limiting overallocation to 3 elements
(significantly reducing space consumption from Py2.3) and running faster
than the previous checkin.

The first part of the growth pattern (0, 4, 8, 16) neatly meshes with
allocators that trigger data movement only when crossing a power of two
boundary.  Also, then even numbers mesh well with common data alignments.
2004-02-14 18:34:46 +00:00
Raymond Hettinger 238b267bf6 Lists are measured in elements not bytes. 2004-02-13 21:50:27 +00:00
Raymond Hettinger 7a6d297bda * Note list optimizations
* Move an example out of a comment.
2004-02-13 19:00:07 +00:00
Fred Drake ce3caf2e7a minor markup improvements 2004-02-12 18:13:12 +00:00
Walter Dörwald 70a6b49821 Replace backticks with repr() or "%r"
From SF patch #852334.
2004-02-12 17:35:32 +00:00
Fred Drake e6ed33a6b3 fix minor markup error: \code{for} --> \keyword{for} 2004-02-12 14:35:18 +00:00
Raymond Hettinger b1e5b50531 SF 895560: minor typo 2004-02-12 09:50:42 +00:00
Fred Drake 29f5933fcb add support for \e to the {alltt} environment 2004-02-10 18:30:22 +00:00
Neal Norwitz d311f1fb9b SF #894428, fix typo 2004-02-10 18:07:16 +00:00
Fred Drake 27da291b2c the \file macro is no longer a good example of where \e can't be used 2004-02-09 21:00:29 +00:00
Fred Drake 52feb81932 support \e in \file and \filenq; this is useful for Windows paths 2004-02-09 20:58:08 +00:00
Andrew M. Kuchling fd0e494c98 Minor edits 2004-02-09 13:23:34 +00:00
Thomas Heller 8178a22e20 Documentation for PyDescr_NewClassMethod was missing - here's at least
the function prototype.

Already backported to release23-maint.
2004-02-09 10:47:11 +00:00
Raymond Hettinger 5de33786a9 SF patch #892821: example for urllib2 has SyntaxError
(Contributed by George Yoshida.)
2004-02-08 20:25:01 +00:00
Raymond Hettinger 3fd977964a Fix misspelled name. 2004-02-08 20:18:26 +00:00
Raymond Hettinger 7820554c2c Fix typo 2004-02-08 20:05:40 +00:00
Raymond Hettinger ce9b4714ef SF patch #880552: Fix typo in usage message(prechm.py)
(Contributed by George Yoshida.)

* Also convert tabs to spaces.
2004-02-08 19:24:18 +00:00
Raymond Hettinger 4c9800d663 SF bug #892854: typo in textwrap doc page
(Reported by Drew Perttula.)
2004-02-08 18:09:32 +00:00
Raymond Hettinger 5c5eb86347 * Incorporate Skip's suggestions for documentation (explain the word deque
comes from and show the differences from lists).
* Add a rotate() method.
2004-02-07 21:13:00 +00:00
Skip Montanaro 7209294112 a couple other sunos4 support items removed 2004-02-07 12:50:19 +00:00
Raymond Hettinger c058fd14a9 * Fix ref counting in extend() and extendleft().
* Let deques support reversed().
2004-02-07 02:45:22 +00:00
Raymond Hettinger 3ba85c2e8a Have deques support high volume loads. 2004-02-06 19:04:56 +00:00
Fred Drake 21ae4f983e minor markup adjustments 2004-02-03 20:55:15 +00:00
Fred Drake 4458ece4d7 Clarify minor point about the ref() and proxy() constructors.
This matches what is already documented for corresponding feature of the C API.
2004-02-03 19:44:26 +00:00
Fred Drake 4d205e366c update dependency information 2004-01-29 15:13:08 +00:00
Raymond Hettinger dd256d97cc Add documentation for collections.deque(). 2004-01-29 07:35:45 +00:00
Raymond Hettinger e52f3b1e56 Add documentation for collections.deque(). 2004-01-29 07:27:45 +00:00
Raymond Hettinger 756b3f3c15 * Move collections.deque() in from the sandbox
* Add unittests, newsitem, and whatsnew
* Apply to Queue.py mutex.py threading.py pydoc.py and shlex.py
* Docs are forthcoming
2004-01-29 06:37:52 +00:00
Fred Drake bd12b181c8 fix whitespace style (inconsistent with the rest of the docs) 2004-01-27 21:08:04 +00:00
Fred Drake fcc51767bd update signature of the socket constructor
(could someone backport this to Python 2.3.x please?)
2004-01-27 18:21:26 +00:00
Fred Drake ee3c6074c3 add missing period 2004-01-26 19:40:18 +00:00
Fred Drake 913829cb1d fix markup 2004-01-26 19:39:13 +00:00
Skip Montanaro db8d1c26d3 add references between getopt and optparse docs 2004-01-26 19:30:21 +00:00
Fred Drake 6d98f198f7 make this distutils doc match the other in using boilerplate.tex 2004-01-26 15:07:31 +00:00
Fred Drake 20d4738a95 no reason not to use boilerplate.tex now that it names the PSF 2004-01-23 15:23:49 +00:00
Fred Drake 0d8da3a622 fix some sloppy markup to use \guilabel 2004-01-23 09:01:56 +00:00
Fred Drake f0f6d12cd4 add \guilabel macro to mark labels that occur in user interfaces 2004-01-23 08:52:28 +00:00
Fred Drake 226f697560 fix method name in example code 2004-01-23 04:05:27 +00:00
Fred Drake 1fe9750200 add direct link to the article in DDJ
closes SF bug #871402
2004-01-21 18:30:28 +00:00
Skip Montanaro ba0485a92d expand on notion of row object type 2004-01-21 13:47:04 +00:00
Skip Montanaro 7895146c40 typo 2004-01-21 13:34:35 +00:00
Raymond Hettinger 734fb5724f Add a Guido inspired example for groupby(). 2004-01-20 20:04:40 +00:00
Andrew M. Kuchling 5303a96808 Add CJK codecs 2004-01-18 15:55:51 +00:00
Hye-Shik Chang 3e2a306920 Add CJK codecs support as discussed on python-dev. (SF #873597)
Several style fixes are suggested by Martin v. Loewis and
Marc-Andre Lemburg. Thanks!
2004-01-17 14:29:29 +00:00
Fred Drake 621b443b8d - add warning that hotshot doesn't work well with threads
- fix some markup
2004-01-16 17:30:16 +00:00
Fred Drake 990a46b732 minor markup improvements 2004-01-16 16:07:04 +00:00
Fred Drake 4977ff0cf5 add a note about memory consumption and LaTeX
closes SF bug #721157
2004-01-13 23:56:03 +00:00
Fred Drake 3f26af765d - add comment about $CUSTOM_BUTTONS
- use_icon(): fix the check for whether a supplemental link is being
  used
2004-01-13 23:43:58 +00:00
Fred Drake 3bbd115735 markup changes 2004-01-13 23:41:32 +00:00
Andrew M. Kuchling 44a98237d8 [Bug #873205] Update URL 2004-01-11 23:00:16 +00:00
Sjoerd Mullender 7e6bbe1516 The format of the string data used in the imageop module is described
as "This is the same format as used by gl.lrectwrite() and the imgfile
module."  This implies a certain byte order in multi-byte pixel
formats.  However, the code was originally written on an SGI
(big-endian) and *uses* the fact that bytes are stored in a particular
order in ints.  This means that the code uses and produces different
byte order on little-endian systems.

This fix adds a module-level flag "backward_compatible" (default not
set, and if not set, behaves as if set to 1--i.e. backward compatible)
that can be used on a little-endian system to use the same byte order
as the SGI.  Using this flag it is then possible to prepare
SGI-compatible images on a little-endian system.

This patch is the result of a (small) discussion on python-dev and was
submitted to SourceForge as patch #874358.
2004-01-10 20:43:43 +00:00
Andrew M. Kuchling c62af02ced Fix some digicool addresses I noticed 2004-01-08 15:01:08 +00:00
Fred Drake 115147921c add link to the red-dove.com page about the logging package 2004-01-08 14:59:02 +00:00
Fred Drake 4f687b3051 add new reference macro: \seelink 2004-01-08 14:57:27 +00:00