Commit Graph

6481 Commits

Author SHA1 Message Date
Barry Warsaw 65367ca41e Add a missing import. Closes SF # 816344. 2003-11-21 20:28:15 +00:00
Andrew M. Kuchling dff9dbdb38 Add two items 2003-11-20 22:22:19 +00:00
Martin v. Löwis af7dc8d8b8 Patch #831747: Add skip_accept_encoding parameter to putrequest. 2003-11-19 19:51:55 +00:00
Barry Warsaw f8d3bcc77e Generator's constructor: The documentation was incorrect regarding how
header wrapping gets done when maxheaderlen <> 0.  The header really
gets wrapped via the email.Header.Header class, which has a more
sophisticated algorithm than just splitting on semi-colons.
2003-11-19 02:22:36 +00:00
Martin v. Löwis 8bafb2aaca Patch #843088: Fix typos. Backported to 2.3. 2003-11-18 19:48:57 +00:00
Raymond Hettinger 65674b80fc Documentation for set objects. 2003-11-18 17:50:34 +00:00
Raymond Hettinger a690a9967e * Migrate set() and frozenset() from the sandbox.
* Install the unittests, docs, newsitem, include file, and makefile update.
* Exercise the new functions whereever sets.py was being used.

Includes the docs for libfuncs.tex.  Separate docs for the types are
forthcoming.
2003-11-16 16:17:49 +00:00
Raymond Hettinger d456849f19 Fix typo 2003-11-16 13:44:19 +00:00
Andrew M. Kuchling 981a918575 Various edits 2003-11-13 21:33:26 +00:00
Gregory P. Smith b845ef056a remove "support" for BerkeleyDB 3.1, it hasn't worked for a long time 2003-11-13 08:30:03 +00:00
Raymond Hettinger 7d1dd04334 Fix typo 2003-11-12 16:42:10 +00:00
Raymond Hettinger bc3cba2881 Explain the advantages of reversed. 2003-11-12 16:39:30 +00:00
Raymond Hettinger 607c00f792 Present each feature in terms of what makes it useful or desirable. 2003-11-12 16:27:50 +00:00
Raymond Hettinger ad983e79d6 Improve the implementation of itertools.tee().
Formerly, underlying queue was implemented in terms of two lists.  The
new queue is a series of singly-linked fixed length lists.

The new implementation runs much faster, supports multi-way tees, and
allows tees of tees without additional memory costs.

The root ideas for this structure were contributed by Andrew Koenig
and Guido van Rossum.
2003-11-12 14:32:26 +00:00
Fred Drake d85ed1b7fc fix typo in markup 2003-11-10 14:50:54 +00:00
Fred Drake 28eae084bf fix use of undefined markup 2003-11-10 14:48:48 +00:00
Fred Drake dbe7980d6a add missing "if" 2003-11-10 14:43:16 +00:00
Martin v. Löwis 75aa4db04b Mention that getsid is new in 2.4. 2003-11-10 06:46:15 +00:00
Martin v. Löwis d8921379e9 Patch #798297: Add IMAP THREAD command. 2003-11-10 06:44:44 +00:00
Martin v. Löwis 49ee14dac5 Patch #839038: Add getsid(2). 2003-11-10 06:35:36 +00:00
Alex Martelli c516b0e47c clarified (in the 5.14 summary) that tests and comparisons all chain,
added a specific \ref to 5.9 in lieu of previous vague "see above".
(same as commit of Sun Nov 2 to the release23-maint branch)
2003-11-09 16:33:56 +00:00
Alex Martelli 37dc334276 Add docs for readmodule_ex and its function-descriptors, fixing
sf bug#812818.
(same as commit of Sun Nov 2 to the release23-maint branch)
2003-11-09 16:32:54 +00:00
Alex Martelli 50324a604c Avoid giving advice that's bad for security, as per SF bug #823515
(same as commit of Sun Nov 2 to the release23-maint branch)
2003-11-09 16:31:18 +00:00
Brett Cannon 35d8360bf7 Document Py_RETURN_NONE. 2003-11-09 04:15:30 +00:00
Andrew M. Kuchling f7a6b67e5c Add 'see also' section pointing to the PEP 2003-11-08 16:05:37 +00:00
Andrew M. Kuchling 1a420251cf Add some recent changes 2003-11-08 15:58:49 +00:00
Michael W. Hudson ff1f194982 Fix the problem addressed by patch
[ 819012 ] Fix for former/latter confusion in Extending documentation

although not by using supplied patch.
2003-11-07 11:45:34 +00:00
Raymond Hettinger dc62aeca4c Add a new looping idiom 2003-11-07 01:30:58 +00:00
Martin v. Löwis 5ce2fecf8e Patch #837322: Clarify owning, borrowing, stealing. Backported to 2.3. 2003-11-06 21:08:11 +00:00
Raymond Hettinger 85c20a41df Implement and apply PEP 322, reverse iteration 2003-11-06 14:06:48 +00:00
Neil Schemenauer f607fc5395 Add traceback.format_exc(). 2003-11-05 23:03:00 +00:00
Raymond Hettinger 83c187460e SF patch #834444: add versionadd to new functions
(Contributed by George Yoshida.)
2003-11-02 09:50:56 +00:00
Andrew M. Kuchling b4b9ced1b6 [Bug #817178] Fix incorrect arguments in example, noted by Terry Reedy 2003-10-31 19:52:30 +00:00
Martin v. Löwis 893ffa4372 Patch #830858: Correct the number of is-functions. Backported to 2.3 and 2.2. 2003-10-31 15:35:53 +00:00
Martin v. Löwis 45394c281d Patch #531629: Add multicall support. 2003-10-31 13:49:36 +00:00
Martin v. Löwis 48440b7c27 Patch #: Add POP3 over SSL support. 2003-10-31 12:52:35 +00:00
Raymond Hettinger 9885c93b99 Fix typo. 2003-10-30 06:08:32 +00:00
Brett Cannon 82b24827f6 Minor grammatical fix. 2003-10-30 05:42:15 +00:00
Raymond Hettinger 0a9b9da0c3 Add list.sorted() classmethod. 2003-10-29 06:54:43 +00:00
Raymond Hettinger c43a7e7c37 SF bug #827902: ctime is not creation time
New fix for this bug recognizes differing definitions on various systems.
2003-10-29 00:46:19 +00:00
Armin Rigo 3be6d5d320 Documented gc.get_referrers() as dangerous.
SF bug 793822
2003-10-28 12:10:38 +00:00
Raymond Hettinger 8476c4df92 SF bug #827902: ctime is not creation time
Document the correct definition of os.path.getctime()
2003-10-27 20:00:36 +00:00
Andrew M. Kuchling b546be2448 Fix inaccuracy: all entities from XHTML 1.0 are supported (according to text further down in this file) 2003-10-27 15:46:16 +00:00
Raymond Hettinger 9c7ed4c6df Document that varlist can be NULL. 2003-10-26 17:20:07 +00:00
Raymond Hettinger d591f666de Replace the window() example with pairwise() which demonstrates tee(). 2003-10-26 15:34:50 +00:00
Neal Norwitz 8ed69e3389 SF #829941, update tutorial, built-in types can be base classes since 2.2 2003-10-25 14:15:54 +00:00
Raymond Hettinger 6a5b027742 Added itertools.tee()
It works like the pure python verion except:
* it stops storing data after of the iterators gets deallocated
* the data queue is implemented with two stacks instead of one dictionary.
2003-10-24 08:45:23 +00:00
Andrew M. Kuchling 50a25709f2 Record an item I missed and bump the version number. [2.3 bugfix candidate.] 2003-10-23 18:08:03 +00:00
Fred Drake ee950ff393 - add "Why is Python installed on my computer?" as a documentation FAQ
since this gets asked at the docs at python.org address a lot
- fix some minor style violations and inconsistencies
2003-10-23 14:33:46 +00:00
Andrew M. Kuchling 38afcef3f5 [Bug #809174] loads() and dumps() not documented 2003-10-22 14:12:03 +00:00
Fred Drake d22bb6584d Avoid confusing name for the 3rd argument to str.replace().
This closes SF bug #827260.
2003-10-22 02:56:40 +00:00
Raymond Hettinger f12f32421f Don't make promises about about the visibility of the induction variable. 2003-10-21 18:42:21 +00:00
Fred Drake 4e21dc9efd - make this section format
- start cleaning up the markup for consistency
- comment out the reference to a MS KnowledgeBase article that doesn't
  seem to be present at msdn.microsoft.com; hopefully someone can
  point out an alternate source for the relevant information
2003-10-21 17:58:55 +00:00
Fred Drake 5e75f15008 add missing dependency 2003-10-21 17:25:05 +00:00
Fred Drake 5b6150e066 markup fixes; this would not format 2003-10-21 17:04:21 +00:00
Fred Drake 86c60ed198 ConfigParser.items() and SafeConfigParser.items() no longer return a
generator.  See SF bug #818861.
2003-10-21 16:50:55 +00:00
Andrew M. Kuchling 6aedcfcd1e Add some more items 2003-10-21 12:48:23 +00:00
Andrew M. Kuchling 2fb4d51976 Document list.sort() changes 2003-10-21 12:31:16 +00:00
Guido van Rossum 0c9a318d64 Use 'predicate = bool' as the default predicate for ifilter[false]. 2003-10-20 17:01:07 +00:00
Walter Dörwald f0dfc7ac5c Fix a bunch of typos in documentation, docstrings and comments.
(From SF patch #810751)
2003-10-20 14:01:56 +00:00
Martin v. Löwis 01a74b2fa1 Make CObjects mutable. Fixes #477441. 2003-10-19 18:30:01 +00:00
Martin v. Löwis 95cf84a4f3 Patch #821093: Fix various typos. 2003-10-19 07:32:24 +00:00
Gustavo Niemeyer d969775d9c Fixed \versionadded for the (?(id/name)yes|no) expression support. 2003-10-18 15:28:22 +00:00
Martin v. Löwis 6828e18a6a Patch #825679: Clarify semantics of .isfoo on empty strings.
Backported to 2.3.
2003-10-18 09:55:08 +00:00
Martin v. Löwis 849a972f35 Patch #809535: Mention behaviour of seek on text files. Backported to 2.3. 2003-10-18 09:38:01 +00:00
Gustavo Niemeyer ad3fc44ccb Implemented non-recursive SRE matching. 2003-10-17 22:13:16 +00:00
Thomas Heller 41e2809feb Typo found by Lokasz Pankowski:
dir_created -> directory_created
2003-10-16 19:40:48 +00:00
Raymond Hettinger 42b1ba31af * list.sort() now supports three keyword arguments: cmp, key, and reverse.
key provides C support for the decorate-sort-undecorate pattern.
  reverse provide a stable sort of the list with the comparisions reversed.

* Amended the docs to guarantee sort stability.
2003-10-16 03:41:09 +00:00
Brett Cannon 4fc3855fb2 Initial checkin of docs for Lib/platform.py .
Closes patch #785752 and bug #726911.

Should be backported after correctness and such has been verified by Fred.
2003-10-14 21:45:59 +00:00
Raymond Hettinger c2a2832bee SF bug #821701: reduce docs neglect a very important piece of information.
Add a note showing which argument is the accumulator.
2003-10-13 17:52:35 +00:00
Neal Norwitz 7decf5e5af SF #822262, Typo in Doc/api/intro.tex 2003-10-13 17:47:30 +00:00
Raymond Hettinger cb2da43db8 Extended tuple's C API to include a new function, PyTuple_Pack() that is
useful for rapidly building argument tuples without having to invoke the
more sophisticated machinery of Py_BuildValue().
2003-10-12 18:24:34 +00:00
Raymond Hettinger aac6ae9f26 SF patch #819955: Erroneous \seemodule in tarfile docs
(Contributed by Johannes Gijsbers.)
2003-10-12 02:02:16 +00:00
Fred Drake 40b9df2fea add some information about using graphics with the Python document
classes
2003-10-11 05:25:24 +00:00
Thomas Heller 95a97d59c0 Fix a typo, discovered by Joonas Paalasmaa.
Backported to 2.3
2003-10-08 12:01:33 +00:00
Raymond Hettinger dbe3d280e7 Adopt Christian Stork's suggested argument order for the logic quantifiers.
Adopt Jeremy Fincher's suggested function name, "any", instead of "some".
2003-10-05 16:47:36 +00:00
Raymond Hettinger 2f726e9093 SF bug #812202: randint is always even
* Added C coded getrandbits(k) method that runs in linear time.
* Call the new method from randrange() for ranges >= 2**53.
* Adds a warning for generators not defining getrandbits() whenever they
  have a call to randrange() with too large of a population.
2003-10-05 09:09:15 +00:00
Fred Drake 664a27133c - don't re-write a SourceForge authenticated CVS root into the
anonymous flavor unless the user asks for it on the command line
- decompose SourceForge authenticated CVS roots correctly
2003-10-03 15:21:38 +00:00
Skip Montanaro dffeed3ffa Make the fieldnames argument optional in the DictReader. If self.fieldnames
is None, the next row read is used as the fieldnames.  In the common case,
this means the programmer doesn't need to know the fieldnames ahead of time.
The first row of the file will be used.  In the uncommon case, this means
the programmer can set the reader's fieldnames attribute to None at any time
and have the next row read as the next set of fieldnames, so a csv file can
contain several "sections", each with different fieldnames.
2003-10-03 14:03:01 +00:00
Fred Drake 6f75a364e8 normalize whitespace 2003-10-02 16:30:17 +00:00
Fred Drake a6008d08fa Make sure the trunk Makefile doesn't require mkhowto to be "installed"
as described in "Documenting Python".
2003-10-01 18:49:55 +00:00
Fred Drake efb3a161c3 Various minor updates in the description of mkhowto. 2003-10-01 04:15:09 +00:00
Fred Drake 4e3a27789a no longer assign into sys; "print chevron" is the way to go 2003-10-01 04:07:44 +00:00
Fred Drake 94b3463f7e We're long past worrying about Python versions older than 1.5.2;
remove old compatibility definition of os.path.abspath().
2003-10-01 04:03:54 +00:00
Fred Drake 1dc3bb4722 Work around minor markup issue: we don't want markup to escape into
the module index.
2003-09-30 20:00:43 +00:00
Fred Drake 292f5970ab Fix stupid style bug in a second place. 2003-09-30 15:43:20 +00:00
Fred Drake c504c20e5a Fix stupid style bug. 2003-09-30 15:40:33 +00:00
Fred Drake 1da0bba420 Update to match the version used to build the 2.3.2c1 documentation. 2003-09-29 17:26:08 +00:00
Fred Drake 69db2b967a - change computation of VERSION to use tools/getversioninfo; this is
more reliable than using the $Revision$ expansion
- $RELEASE is no longer needed; we can just use $VERSION now
2003-09-28 22:14:29 +00:00
Fred Drake 984920bbad Make the embedded hyperlinks work. 2003-09-28 19:03:36 +00:00
Fred Drake b36615d584 - update pkglist.html more frequently, and explain why that's helpful
- add a comment explaining what pkglist.html is for
2003-09-28 16:25:43 +00:00
Fred Drake f7a0d68708 Update the list of directories passed to py2texi.el. The ordering was
wrong, and commontex/ needed to be added.
2003-09-28 03:11:09 +00:00
Fred Drake d4956aac96 Make the "path math" more robust, and support both relative and
absolute paths as input.
2003-09-28 03:10:09 +00:00
Fred Drake c8083cf1cc Load the version information from ../Include/patchlevel.h, so there are
fewer changes to make to version numbers after a release.
2003-09-27 22:07:05 +00:00
Raymond Hettinger 43b5e40795 * Fix markup.
* Fix entry order:
  -  >>> before ...
  - __slots__ in the S section (like __future__ is in the F section)

Need to test the repaired(?) link to Guido's webpage.

Still needs to have the module reference links made relative to
the module directory instead of the tut directory.  That will
require Fred's magic touch.
2003-09-27 20:19:02 +00:00
Thomas Heller 6122c12031 re.sub expands escape sequences in it's second argument.
Will backport to 2.3 myself.
2003-09-27 19:35:37 +00:00
Thomas Heller b7c95290de Typo: documnetation -> documentation
Will backport to 2.3
2003-09-27 19:32:04 +00:00
Fred Drake d4a1419f53 Lots of markup corrections. Some are minor, but others are not: the
contents of an \item should not be enclosed in a group!
2003-09-27 18:59:43 +00:00
Fred Drake cc2e48dd79 Make sure LaTeX2HTML's $TEXINPUTS variable is initialized to include
directories identified in the TEXINPUTS environment variable.
I think this is the last part of the fix for the version number
problems seen in the documentation for the 2.3.1 release.
2003-09-27 16:04:23 +00:00
Fred Drake e1b38c48fa update one more reference to a file that moved from texinputs/ to
commontex/
2003-09-27 07:48:25 +00:00
Fred Drake 0d86ea71b5 Adjust the organization a bit and update some of the comments to
better explain what's happening.
2003-09-27 07:37:09 +00:00
Fred Drake 2bc9b2fa2c add commontex/ to the list of directories described here 2003-09-27 07:18:52 +00:00
Fred Drake bac3f04000 point to the new location of the license information 2003-09-27 07:16:32 +00:00
Fred Drake 410825ac8b Move content input files shared among the documents into a new directory
(commontex/), leaving only style support files in texinputs/.  This makes
texinputs/ part of the formatting tools while commontex/ is strictly part
of the actual documentation.
2003-09-27 07:11:17 +00:00
Fred Drake 2ee37ff191 - use string methods
- make TEXINPUTS work the way it's supposed to in TeX-ish tools
2003-09-27 07:05:12 +00:00
Fred Drake e395e2278c Fix the most recent change to the invocation of the mkhowto script so
that it works for all targets.

The issue here is that there are two different levels in the directory
tree at which we execute mkhowto, so we can't define it just once
using a relative path (at least not with the current implementation
and Makefile structure).  We use the GNUish $(shell) function here to
work around that restriction by identifying mkhowto using an absolute
path.
2003-09-27 05:52:16 +00:00
Raymond Hettinger 5a25aa6c4a Fix spelling and add markup. 2003-09-27 05:42:14 +00:00
Andrew M. Kuchling 7cf4d9bf19 [Bug #812936] Correct the documentation for RotatingFileHandler.
[2.3 bugfix candidate]
2003-09-26 13:45:18 +00:00
Fred Drake df49324c0b define a variable to specify the mkhowto program itself, as for any
other application
2003-09-25 15:25:37 +00:00
Thomas Heller 39cb54b375 Typo: sys.prefex -> sys.prefix
Closes SF# 812152

Baskport candidate for release23-main
2003-09-25 06:26:46 +00:00
Skip Montanaro 40d4bc5934 Add a glossary to the tutorial. Also generate an index. At the moment this
mostly only references glossary entries.
2003-09-24 16:53:02 +00:00
Skip Montanaro 757dedc1a3 first cut at a glossary 2003-09-24 16:51:23 +00:00
Fred Drake 2348afd3f8 - update to reflect that base classes can be class types as well as
"classic" class objects
  [partially fixes SF bug #453684]

- add note that new-style classes can use descriptors to implement
  instance variables in different ways
2003-09-24 04:11:47 +00:00
Raymond Hettinger 16434b5e25 Fix whitespace in example 2003-09-24 03:58:56 +00:00
Thomas Heller ccfbfb9ea5 Change the default window size to 1024x768. This shows at least the
whole main page.

Support 2.3 and 2.4 docs in HTMLHelp format.

Already 'backported' to release-23maint.
2003-09-23 20:50:47 +00:00
Raymond Hettinger 9a80c5dbc4 Added codec for bz2 compression. 2003-09-23 20:21:01 +00:00
Fred Drake 09fad27a29 add entry for 2.3.1 2003-09-23 05:21:49 +00:00
Raymond Hettinger 92016dcc91 SF 810242. Fix doubled word errors. 2003-09-22 15:27:11 +00:00
Raymond Hettinger 7e43110f34 SF 810242. Fix doubled word errors. 2003-09-22 15:00:55 +00:00
Raymond Hettinger 1e80359733 Clean-up example code: remove string module and backticks. 2003-09-22 06:25:10 +00:00
Gregory P. Smith e94040a1ed minor correction. python 2.3 was released with the bsddb module 4.1.6 not 4.1.1 2003-09-21 23:41:02 +00:00
Martin v. Löwis e7a9796a0f Patch #800697: Add readline.clear_history. 2003-09-20 16:08:33 +00:00
Martin v. Löwis c6bb6c0f8c Patch #707167: Pass dircache exceptions to the caller. Fixes #682813.
Not backported because of behaviour change.
2003-09-20 15:52:21 +00:00
Martin v. Löwis 7bdc484c97 Patch #808362: Fix typos. 2003-09-20 11:09:28 +00:00
Thomas Heller a425dbc7ce Fix a typo found by Eric D. Moyer, closes SF 807813.
Will backport to 2.3.
2003-09-17 17:11:01 +00:00
Raymond Hettinger d21fd7bd86 * Minor wording change
* Reference the doctest.DocTestSuite() conversion tool.
2003-09-16 22:04:31 +00:00
Raymond Hettinger 3404034a21 Minor fixups 2003-09-16 21:45:22 +00:00
Raymond Hettinger 1e4cf67c32 SF bug #804113: Crypto terminology for crypto hash function
Noted that the SHA algorithm is really SHA-1.
(Contributed by Ronald Rivest.)
2003-09-15 18:20:52 +00:00
Raymond Hettinger deadbf50e4 SF #662923
Add support for the iterator and mapping protocols.
For Py2.3, this was done for shelve, dumbdbm and other mapping objects, but
not for bsddb and dbhash which were inadvertently missed.
2003-09-12 06:33:37 +00:00
Raymond Hettinger 74c8e55f3b SF bug #804280: fromkeys is not listed in index 2003-09-12 00:02:37 +00:00
Fred Drake 614438ab06 fix markup buglets 2003-09-11 18:18:54 +00:00
Fred Drake f5c87c4d99 - added many links into the library reference
- removed use of the string module
- fixed some broken markup
2003-09-11 06:06:26 +00:00
Fred Drake 626d472edd - add several links into the library reference
- update a couple of URLs to point to more recent portions of
  python.org
2003-09-11 04:28:13 +00:00
Fred Drake 11b138fbf7 remove useless <br/> from the top navigation panel 2003-09-11 04:14:20 +00:00
Fred Drake 4587fa21ea try to fix up the padding inside a notice environment so they fit in a
little better, with similar spacing characteristics with the seealso
environment
2003-09-11 04:08:47 +00:00
Fred Drake 7c4d8f3ca9 - add version annotation for HIGHEST_PROTOCOL
- cleaned up some markup
2003-09-10 20:47:43 +00:00
Brett Cannon 62dba4c277 select.select() now accepts a sequence (as defined by PySequence_Fast()) for
its first three arguments.

Closes RFE #798046 .
2003-09-10 19:37:42 +00:00
Skip Montanaro fd4fa8801a mention new module doc display feature of pydoc in libref and NEWS 2003-09-10 19:04:13 +00:00
Raymond Hettinger 6e380cd1d8 SF bug #803679: Missing section number in csv module documentation 2003-09-10 18:54:49 +00:00
Raymond Hettinger 5bcc933211 SF bug #803842: Wrong description of regexp concatenation 2003-09-10 18:45:12 +00:00
Raymond Hettinger 0d6e8cde1a SF bug #802302: Invalid documentation for dbhash.
The documentation severely departed for the actual implementation.
2003-09-10 04:44:29 +00:00
Raymond Hettinger bed92ee2b2 SF patch #800899: Making "|" directive from REs a bit clearer. 2003-09-10 03:54:50 +00:00
Raymond Hettinger 9756f388c0 Fix typo. 2003-09-10 00:11:28 +00:00
Fred Drake f5f0c17b85 end-of-sentence punctuation comes *before* \footnote, not after 2003-09-09 19:49:18 +00:00
Raymond Hettinger dfa7bd97ff SF #801306: Bad RE in scanf example 2003-09-09 01:30:13 +00:00
Raymond Hettinger 74923d73ee SF bug #560286: Add docs for 'basestring' 2003-09-09 01:12:18 +00:00
Raymond Hettinger a098b33c93 Add an example to address a common question of how to split iterators. 2003-09-08 23:58:40 +00:00
Raymond Hettinger f350160d43 Fix spacing markup and other sundries. 2003-09-08 19:01:04 +00:00
Raymond Hettinger b67449d31d Fix spacing markup and other sundries. 2003-09-08 18:52:18 +00:00
Fred Drake a26c16c821 fix \NULL with following space and no {} (two instances) 2003-09-07 02:33:37 +00:00
Fred Drake 4ccf6e738e fix \NULL with following space and no {} 2003-09-07 02:32:55 +00:00
Brett Cannon 77e0212b8a Fix minor LaTeX bug of not ending a \NULL{} with the curly braces to get the
spacing correct in the output.
2003-09-07 02:22:16 +00:00
Fred Drake 60e868abd2 - reorganize sections
- correct section level error (module references are always \section)
- many markup revisions, including some minor rewordings
2003-09-06 17:51:16 +00:00
Fred Drake 5b52717130 add missing dependency 2003-09-06 06:42:01 +00:00
Raymond Hettinger 99812134be SF bug 799191: fix markup 2003-09-06 05:47:31 +00:00
Raymond Hettinger 1c90a6754c SF bug 799367: grammar error 2003-09-06 05:36:13 +00:00
Raymond Hettinger 951976dc9f SF bug #801486: Markup error. 2003-09-06 04:39:54 +00:00
Fred Drake c8b08b446a add a note about how \ulink should be different than it actually is
for PDF generation
2003-09-06 04:19:43 +00:00
Fred Drake 38f6b8845b Elaborate the explanation of different flavors of _* identifiers.
Fixes SF bug #520325.
2003-09-06 03:50:07 +00:00
Fred Drake c0678ffc60 - create a hyperlink for a section reference (also more robust in the
face of section re-ordering)
- fix minor markup nits for better presentation
2003-09-06 03:33:32 +00:00
Fred Drake f3552130e2 avoid spurious vertical whitespace preceeding heading which are marked
with a \label
2003-09-06 01:10:14 +00:00
Fred Drake 74530ff4f9 markup updates 2003-09-05 15:50:20 +00:00
Fred Drake 1b1ca0cc2b normalize whitespace; detabify 2003-09-05 15:43:58 +00:00
Fred Drake 41aa018398 fix some nuissance formatting problems for the "alltt" environment;
there's still a bug for the environment, but that's worked around in
this change as well
2003-09-05 15:43:00 +00:00
Fred Drake d37154f7f2 normalize whitespace 2003-09-05 15:36:23 +00:00
Fred Drake a1a1dba2d4 add index entry 2003-09-05 14:06:35 +00:00
Fred Drake 6a002cafa2 fix minor markup nits 2003-09-05 14:01:15 +00:00
Fred Drake 911e571a1c add a relevant "see also" link 2003-09-05 13:59:10 +00:00
Fred Drake 929d95957b make the padding inside a "See also" box more consistent around the
sides
2003-09-05 13:58:26 +00:00
Fred Drake b24e84c558 clean up some markup 2003-09-05 13:48:02 +00:00
Fred Drake 7a55642ff6 normalize whitespace 2003-09-04 22:21:17 +00:00
Fred Drake 0739c44bbd Suppress more online-only navigation in the printed HTML. 2003-09-04 22:16:45 +00:00
Fred Drake ecbfceb31c make sure cells are really generated for all table cells, even those
that are left empty
fixes first of the problems reported in SF bug #727692
2003-09-04 21:25:03 +00:00
Fred Drake b79f343e61 adjust markup to avoid suppressing a word space in content 2003-09-04 19:52:02 +00:00
Fred Drake 859c46a1fd Make the redundent portion of the lower navigation area disappear from the
printed version for browsers that support "@media print" in CSS.
2003-09-04 19:30:15 +00:00
Martin v. Löwis ef36537b81 Patch #792338: Correct documentation for timetuple return type. 2003-09-04 18:29:53 +00:00
Martin v. Löwis 25f90d5c5d Use de_DE in example, change message for unknown locale. Fixes #797447.
Will backport to 2.3.
2003-09-03 04:50:13 +00:00
Raymond Hettinger 09c7b6075c SF patch #798255: Document httplib.HTTPResponse.read "amt" argument
(Contributed by Jeff Epler.)
2003-09-02 02:32:54 +00:00
Raymond Hettinger aa1178b811 Minor typo 2003-09-01 23:13:04 +00:00
Raymond Hettinger c75c3e0392 SF patch #791153: inconsistency with implementation(logging)
(Contributed by George Yoshida.)
2003-09-01 22:50:52 +00:00
Raymond Hettinger 6f6d7b93bc SF bug #797853: Small problems with the csv module's documentation 2003-08-31 05:44:54 +00:00
Raymond Hettinger 2f3e5483a3 SF bug #732120:An extended definition of "non-overlapping" would save time.
Clarified the meaning of non-overlapping in patterns with zero length
matches.
2003-08-31 05:29:02 +00:00
Raymond Hettinger 0a6aa28681 SF patch #797157: Bug 794658: os.chmod docs, stat constants
(Contributed by Christos Georgiou.)

Reference the symbol definitions in the stat module.
2003-08-31 05:09:52 +00:00
Raymond Hettinger 9d12ab5c3c Fix long option markup. 2003-08-31 04:20:12 +00:00
Raymond Hettinger 8170200ce2 SF patch #797180: Bug 792656: slicing explained 2003-08-30 23:31:31 +00:00
Raymond Hettinger 57d71289a1 SF patch #797868: Tutorial, sec. 5.1.4 could contain an extra example
(Revised from the original patch contributed by Michal Pasternak.)

Also, make a couple minor fixups elsewhere.
2003-08-30 23:21:32 +00:00
Andrew M. Kuchling 77ad829261 [Bug #780231] One of the changes described in the 2.3 "What's New" document
actually occurred in 2.2.  Move the description to whatsnew22.tex.

[Bugfix candidate -- I'll backport to 2.3 (another 2.2 bugfix seems unlikely)
2003-08-29 17:49:26 +00:00
Fred Drake 9e78d1e1e5 fix minor syntactic faux pas 2003-08-29 04:09:26 +00:00
Fred Drake 4f4dbef2ca remove extra word occurance; reported to webmaster 2003-08-27 15:11:40 +00:00
Raymond Hettinger 9e3864190c Make the derived tools amendable to cut and paste. 2003-08-25 05:06:09 +00:00
Raymond Hettinger 9bd308f67b Fix doubled word typos. 2003-08-25 04:43:53 +00:00
Raymond Hettinger e41d4c8ec9 Added doubled word warnings. 2003-08-25 04:39:55 +00:00
Raymond Hettinger 999b57c872 Fix double word typos. 2003-08-25 04:28:05 +00:00
Raymond Hettinger 9ac25ec025 SF bug #793702: Section 13.1 HTMLParser documentation error
The -- is special to TeX and was printing as just -.
2003-08-25 03:31:28 +00:00
Raymond Hettinger c2a5cb2327 Fix typo.
Thou shalt not count to two unless proceeding to the number three.
2003-08-23 03:49:08 +00:00
Raymond Hettinger f4bb1f946e Fix typo. 2003-08-23 03:38:11 +00:00
Greg Ward 4892381207 Fix a loooong-standing brainfart: I got the site-packages path for
Python 1.5.2 wrong in the section on config files.
2003-08-23 02:09:18 +00:00
Barry Warsaw 463c5a868f Update get_param() description to reflect changes to the docstring. 2003-08-19 04:26:59 +00:00
Raymond Hettinger 6a1801271a Improvements to set.py:
* Relaxed the argument restrictions for non-operator methods.  They now
  allow any iterable instead of requiring a set.  This makes the module
  a little easier to use and paves the way for an efficient C
  implementation which can take better advantage of iterable arguments
  while screening out immutables.

* Deprecated Set.update() because it now duplicates Set.union_update()

* Adapted the tests and docs to include the above changes.

* Added more test coverage including testing identities and checking
  to make sure non-restartable generators work as arguments.

Will backport to Py2.3.1 so that the interface remains consistent
across versions.  The deprecation of update() will be changed to
a FutureWarning.
2003-08-17 08:34:09 +00:00
Fred Drake 236ffba400 Adjust some horizontal indentation to be consistent with the style used
throughout the documentation.
2003-08-16 06:30:47 +00:00
Raymond Hettinger 7ceb29e4a5 Incorporate documentation suggestions from feedback on comp.lang.python.
* Positive wording for the description of why < and > and = can all
  be False.

* Move to a three column table format that puts long method names
  side-by-side with their operator equivalents

* Mention that KeyError can be raised by Set.pop() and Set.remove().

* Minor tweaks to the examples.

Will backport as soon as Fred rebuilds the docs so I can confirm
the tables formatted properly
2003-08-16 00:56:40 +00:00
Neil Schemenauer 90b182c16c Don't introduce map(None, ...) in the tutorial. In practice, zip() is
usually preferred.
2003-08-14 22:57:46 +00:00
Raymond Hettinger fb857893a2 SF patch #787929: reflect the introduce of boolean type(libcfgparser.tex)
(Contributed by George Yoshida.)
2003-08-14 19:58:35 +00:00
Fred Drake 8fd8def1fa fix markup 2003-08-14 04:51:24 +00:00
Andrew M. Kuchling 69f31eb80c [Patch #739124] Add use_default_colors() to curses module 2003-08-13 23:11:04 +00:00
Raymond Hettinger c7a26562f9 SF patch#786531 'the the' typo. Contributed by George Yoshida 2003-08-12 00:01:17 +00:00
Raymond Hettinger f17d65da3a SF patch#786531 'the the' typo. Contributed by George Yoshida 2003-08-12 00:01:16 +00:00
Skip Montanaro bc961e5714 add a statement identifying StringI and StringO objects. 2003-08-11 15:06:07 +00:00
Raymond Hettinger 12c484dab8 SF patch #783807: Clarify PySequence_Setitem ref counting
(Contributed by Jay T Miller.)
2003-08-09 04:37:14 +00:00
Raymond Hettinger 0eec08794c Explain argument unpacking 2003-08-08 23:32:46 +00:00
Raymond Hettinger 6e13bcc7b1 SF bug #775836: change 0,1 to False,True in dict.has_key doc 2003-08-08 11:07:59 +00:00
Raymond Hettinger b5a420883c Modified itertools.izip() to match the behavior of __builtin__.zip()
which can now take zero arguments.
2003-08-08 05:10:41 +00:00
Raymond Hettinger c7d7766fda Improve docs:
* Simplify the pure python examples
* Add a quantify() example
2003-08-08 02:40:28 +00:00
Fred Drake bb18f620ad Fix hyperlinks and one class reference.
Backporting to Python 2.3 branch.
2003-08-07 14:31:08 +00:00
Raymond Hettinger f8a52d38ad Removed deprecated functions 2003-08-05 12:23:19 +00:00
Raymond Hettinger 02771c174c SF patch #782810: typo in libfuture.tex
(Contributed by George Yoshida)
2003-08-05 11:40:21 +00:00
Martin v. Löwis cebcc61d4d Patch #781126: Fix markup for add_fallback. Will backport to 2.3. 2003-08-05 05:54:15 +00:00
Fred Drake 5d9c636faf init_myformat(): None of the "mark" values can be empty strings, or
LaTeX2HTML feels free to remove a surrounding element that
    contains no other content.  Since such an element is typically a
    named anchor used for hyperlinking, they should not be removed.
    Unfortunatley, making sure these marks are non-empty is the most
    direct way of avoiding this behavior.

Thanks to Dave Kuhlman for tracking this down; this was some excellent
detective work!
2003-08-05 05:00:23 +00:00
Brett Cannon b278ac4e46 Add note about fileno not being usable as a normal file descriptor in Windows. 2003-08-05 03:51:24 +00:00
Fred Drake e0c1740bc5 better support for well-formed XHTML 2003-08-05 03:48:29 +00:00
Fred Drake 2fc88a62d4 make the portions of the generated HTML produced by these styles better
conform to XHTML rules.
2003-08-05 03:45:37 +00:00
Raymond Hettinger 4ee2ff36d0 Clarified that TypeErrors can be raised by any
function (not just builtins).

The issue arose in a thread on comp.lang.python.
2003-08-04 08:33:50 +00:00
Raymond Hettinger eaef615116 As discussed on python-dev, changed builtin.zip() to handle zero arguments
by returning an empty list instead of raising a TypeError.
2003-08-02 07:42:57 +00:00
Skip Montanaro 3576f0a6a4 Everyone knows what Fred meant, but I thought I'd make it official... ;-) 2003-07-31 01:17:22 +00:00
Fred Drake 7d597d911f Generalize the template for the "What's New" document so it's easier
to extract next time without having to remember where in CVS to dig it
out.
2003-07-30 23:52:16 +00:00
Fred Drake 90b20494a1 there's a new "What's New" for Python 2.4 2003-07-30 19:14:54 +00:00
Fred Drake ed0fa3da9f boilerplate to start off "What's New in Python 2.4" 2003-07-30 19:14:09 +00:00
Fred Drake afc0d8e893 Update to the same version info used by the interpreter. 2003-07-30 18:43:28 +00:00
Andrew M. Kuchling 68a3294fc4 [Bug #779469] Fix error in example code 2003-07-30 11:55:06 +00:00
Fred Drake 9d843087b6 update the documentation contact address 2003-07-30 02:55:28 +00:00
Fred Drake 333d6fd583 - update the documentation contact address
- remove text about the long-moved Mac OS libref chapter
2003-07-30 02:55:01 +00:00
Andrew M. Kuchling b34ba3f174 Bump version number; record 2.3 release date 2003-07-29 12:06:32 +00:00
Fred Drake 7a7aba9931 Update release information. 2003-07-29 03:20:32 +00:00
Fred Drake 96b49ffbe2 Bump version information. 2003-07-29 03:11:34 +00:00
Fred Drake d50bd6cf00 Update URL. 2003-07-28 14:39:13 +00:00
Fred Drake 98741af170 Bump release number. 2003-07-24 01:22:50 +00:00
Fred Drake a3788642a3 Fix representation of ^= operator in __ixor__() documentation.
Closes SF bug #776181.  Should be backported.
2003-07-23 15:18:03 +00:00
Raymond Hettinger 88821f7c20 Important usability fix in itertools documentation. 2003-07-22 06:33:13 +00:00
Fred Drake f1c9869ab0 Avoid a 301 permanent redirect.
Part of SF patch #773007.

Also fixed a number of mostly cosmetic markup errors.
2003-07-22 01:09:22 +00:00
Fred Drake 644a08c735 Avoid a 301 permanent redirect.
Part of SF patch #773007.
2003-07-22 01:09:22 +00:00
Fred Drake 700c890631 Avoid a few 301 permanent redirects.
Part of SF patch #773007.
2003-07-22 00:52:42 +00:00
Fred Drake ef13949e00 Avoid a 301 permanent redirect.
Part of SF patch #773007.
2003-07-22 00:49:11 +00:00
Fred Drake 6c4970995a Merge the old dumbdbm documetation into the new docs that have been added.
Make some module references hyperlinks.
2003-07-21 15:30:15 +00:00
Andrew M. Kuchling 0ceb9b1603 Change \code to \verb, because TeX merges the two dashes into a
hyphen, resulting in the output '-list-classifiers', not the correct
'--list-classifiers'.  I've verified that the line is now correct
in the DVI, PDF, HTML, and ASCII versions.
2003-07-21 12:49:46 +00:00
Raymond Hettinger 476fcae4d7 SF bug #774411: Typo in socket documentation 2003-07-20 01:10:15 +00:00
Andrew M. Kuchling 95be8bdab7 Add introductory paragraphs
Remove comment about MacOS changes; I'm not going to have time to figure
    out what they are
Move PEP 273 section into numeric order
2003-07-18 02:12:16 +00:00
Andrew M. Kuchling 6e73f9e5db Add a few more items 2003-07-18 01:15:51 +00:00
Andrew M. Kuchling 8744f12a2f Complete the rewrite pass; add a few more items; bump version number to 0.90; remove comment about draft status 2003-07-17 23:56:58 +00:00
Fred Drake 7a6b4f0284 more markup chages 2003-07-17 16:00:01 +00:00
Fred Drake 0106e1dd20 Include the GNU info format in the edist target since we're now
building a fair portion of the documentation as info.
2003-07-17 15:29:16 +00:00
Fred Drake 8836e567b9 - remove mention of the isprivate flag, since that isn't directly
documented here, and according to Tim, should never have been there
- misc. cleanups for consistency
2003-07-17 15:22:47 +00:00
Raymond Hettinger 943277ecd3 Minor corrections. 2003-07-17 14:47:12 +00:00
Fred Drake de7cdb26d1 - put the GNU info packages in the same place as everything else
- add a convenience target to create the package list directly
2003-07-17 11:55:18 +00:00
Fred Drake e5f15ff8cb - update the list of documents for which GNU info is built
- convert tabs to spaces
2003-07-17 05:36:19 +00:00
Fred Drake 7262ca8abf Bump version numbers. 2003-07-17 05:30:38 +00:00
Fred Drake ea690c4b25 - improve the description of how user-defined method
objects get made
  - improve the description of attribute retrieval from
    classes and class instances
  - add brief documentation of static method and
    class method objects.
2003-07-17 05:26:53 +00:00
Fred Drake 38d7c1bb78 Note that Unicode strings are now supported in sys.path.
SF patch #764594.
2003-07-17 04:22:44 +00:00
Fred Drake e8e241b732 Make the howto document class work properly with the pypaper.sty
paper-size hook.
SF patch #772550.
2003-07-17 04:15:35 +00:00
Skip Montanaro bfa6872260 Zap the C API subsection altogether for now. It's not actually usable from
C yet anyway.
2003-07-16 21:14:35 +00:00
Andrew M. Kuchling aa9b39f910 Mention list.index; more small textual changes 2003-07-16 20:37:26 +00:00
Andrew M. Kuchling c760c6c442 Add reminder list of things to document; mention sys.getcheckinterval() and socket.timeout exception 2003-07-16 20:12:33 +00:00
Skip Montanaro 2491cd98c4 expose the C API subsection which was hidden from LaTeX in a comment. In
the info conversion the \comment LaTeX macro mapped to a Texinfo @ignore
macro.  Unfortunately, py2texi.el is not smart enough to avoid generating
links to the @ignore'd section, which causes makeinfo to croak.

Exposing this text is probably not the most correct thing to do, as this
documentation really belongs in the C API manual.  This does get the info
files generated, however, which is a more practical goal considering the
impending release of 2.3rc1.
2003-07-16 19:46:07 +00:00
Raymond Hettinger 4d6e8fe5d1 Clarify the lack of relationship between rich comparison operators.
Prompted by a discussion on comp.lang.python.
2003-07-16 19:40:23 +00:00
Raymond Hettinger 71adf7e9d8 Doctest now examines all docstrings by default. Previously, it would
skip over functions with private names (as indicated by the underscore
naming convention).  The old default created too much of a risk that
user tests were being skipped inadvertently.  Note, this change could
break code in the unlikely case that someone had intentionally put
failing tests in the docstrings of private functions.  The breakage
is easily fixable by specifying the old behavior when calling testmod()
or Tester().  The more likely case is that the silent failure was
unintended and that the user needed to be informed so the test could be
fixed.
2003-07-16 19:25:22 +00:00
Fred Drake 853276e16d Lots of markup cleanups to avoid warnings from the GNU info generation;
these make sense even without that processing chain.
2003-07-16 17:58:38 +00:00
Fred Drake 788617f8f0 Remove \versionchanged; the text was too complex for the GNU info
conversion to support.  Keep the content as normal content, with a
note that this applies starting in Python 2.3.
2003-07-16 16:19:08 +00:00
Andrew M. Kuchling 2cd773160d Minor text changes; update bug/patch count (quite a jump!) 2003-07-16 14:44:12 +00:00
Fred Drake bd5fdd93a9 Make it easier to figure out the where a menuselection starts and ends
by controling the font.
2003-07-16 14:01:56 +00:00
Fred Drake a66b6c1267 Cygwin instructions:
- added missing period
- added markup so it's easier to tell which names are special
2003-07-16 13:50:28 +00:00
Fred Drake d24c767d5b A variety of markup-level adjustments. 2003-07-16 05:17:23 +00:00
Raymond Hettinger 46f681cc07 Discussion of signatures for unicode.translate() and str.translate()
were in the wrong file.  Moved out of libstring.tex and into
libstdtypes.tex.
2003-07-16 05:11:27 +00:00
Fred Drake 6c85bcb2aa - update some comments
- add support for the "What's New" document
- add short aliases for individual documents; nice for debugging
  conversions
2003-07-16 04:02:58 +00:00
Fred Drake fa00f91897 Pass along the selected "What's New" document to the make file for the
GNU info conversion.
2003-07-16 04:01:04 +00:00
Fred Drake 15b3dba85e Adjust description of the internationalized domain name encoding to
better accomodate the GNU info conversion.
2003-07-16 04:00:14 +00:00
Fred Drake 0bb242b67c Map \envvar to the TeXinfo equivalent, @env. 2003-07-16 03:44:48 +00:00
Fred Drake 850026308b Simple support for the alltt environment. 2003-07-16 03:35:41 +00:00
Fred Drake 3605ae5966 In the description of enumerate(), the indexing operators should not
be included in the \var.  This produced weird results in general, but
broke the GNU info conversion.
2003-07-16 03:26:31 +00:00
Fred Drake 7769bb9224 Teach this script about \AA and \aa (the Scandanavian A-ring
characters); \AA is used in whatsnew23.tex.
2003-07-16 03:16:34 +00:00
Raymond Hettinger b233e54409 Nits. 2003-07-15 23:16:01 +00:00
Fred Drake d51ce7de97 Indexing is a mess; try to get the link targets closer to the relevant
text.  There needs to be a better way.
2003-07-15 22:03:00 +00:00
Fred Drake 4e72e0533d process_commands_wrap_deferred:
- fix comment describing what this is for
  - add lots of indexing macros to this call
Closes SF bug #518989.
2003-07-15 22:00:36 +00:00
Fred Drake b3be52eaf4 Try to clean up some indexing relevant to the import statement.
Pertains to SF bug #518989.
2003-07-15 21:37:58 +00:00
Fred Drake e37b4ed24e Discuss calling new-style types.
Closes SF bug #453683.
2003-07-15 20:45:16 +00:00
Fred Drake d9cf8e7e7c Markup consistency nits. 2003-07-14 21:07:05 +00:00
Fred Drake 9753ae1237 Added missing markup. 2003-07-14 20:53:57 +00:00
Raymond Hettinger 708c2a877e Fix unbalanced parenthesis in text. 2003-07-14 18:36:47 +00:00
Raymond Hettinger 0e53d234eb Fix missing parenthesis 2003-07-14 18:24:26 +00:00
Skip Montanaro 7233117960 update norobots link 2003-07-14 17:04:50 +00:00
Skip Montanaro a2d3d93ee3 + libdumdbm 2003-07-14 12:13:27 +00:00
Skip Montanaro 0f59b54f32 + libdumbdbm 2003-07-14 12:12:56 +00:00
Skip Montanaro d54c5ddd28 minimal dumdbm module doc 2003-07-14 12:12:37 +00:00
Raymond Hettinger 9bb33868af SF bug #738090: Section 13.3: htmllib.HTMLParser constructor definition
amendment

Add a clarifying cross-reference to the formatter module.
2003-07-14 08:15:47 +00:00
Raymond Hettinger 5c5fca9844 SF bug #706546: u''.translate not documented
Clarified the difference between translate methods for string objects and
Unicode objects.
2003-07-13 02:06:47 +00:00
Raymond Hettinger 627273733f SF bug #770107: Typo in documentation of resource module 2003-07-13 00:46:40 +00:00
Martin v. Löwis 162f081fb3 Patch 549151, rev4: redirect posts for 301 also. Will backport to 2.2. 2003-07-12 07:33:32 +00:00
Raymond Hettinger a685f52256 Fix missing parenthesis 2003-07-12 04:42:30 +00:00
Raymond Hettinger 6122d0267f SF patch #726751: Clarify docs for except target assignment
Brett found that the tutorial didn't really explain what was happening
with exception targets.  Hopefully, this sheds some light on the subject.
2003-07-12 01:05:37 +00:00
Raymond Hettinger 92f21b13ea Document Jim Fulton's docttest extensions. 2003-07-11 22:32:18 +00:00
Raymond Hettinger fa6cce1fdd Minor fixups and added sections for iterators and generators. 2003-07-11 18:58:11 +00:00
Fred Drake e7f343d0f1 normalize whitespace 2003-07-11 03:36:15 +00:00