Commit Graph

4280 Commits

Author SHA1 Message Date
Brett Cannon a801b6a1fd Backport r54712: document that calling file.next() on a file open for writing
leads to undefined behaviour.
2007-04-27 22:35:57 +00:00
Fred Drake 12c295040c fix some markup errors 2007-04-26 04:43:58 +00:00
Raymond Hettinger 4db90ac485 Fix markup 2007-04-24 22:04:26 +00:00
Georg Brandl 22c00e08bf Bug #1705717: error in sys.argv docs.
(backport from rev. 54939)
2007-04-24 15:10:16 +00:00
Neal Norwitz 112717dd0b Fix SF #1703110, Incorrect example for add_password() (use uri, not host) 2007-04-24 04:54:24 +00:00
Andrew M. Kuchling 9df5fa0d91 Describe undocumented third argument to touchline() 2007-04-11 13:47:58 +00:00
Georg Brandl 4d891193d1 Bug #1685704: use -m switch in timeit docs.
(backport from rev. 54524)
2007-03-22 08:05:53 +00:00
Raymond Hettinger 42f4cfa9b6 Add new example 2007-03-20 21:12:23 +00:00
Georg Brandl c77f6c6ea4 Backport docs for recv_into and recvfrom_into. 2007-03-18 08:26:23 +00:00
Georg Brandl d20046622a RFE #1670167: fix in isinstance() docs.
(backport from rev. 54409)
2007-03-16 08:33:51 +00:00
Georg Brandl abcb4bb276 Patch #1680978: consistently use "alive" instead of "active" in the
thread lib doc.
 (backport from rev. 54392)
2007-03-15 07:38:21 +00:00
Gregory P. Smith 12e8fe63e2 doc update from HEAD. don't list "Unix, Windows" as a platform since that
covers everything now that Mac OS 9 isn't a popular issue.
2007-03-14 07:22:35 +00:00
Gregory P. Smith 5cdefad0e0 doc update from HEAD 2007-03-14 07:20:47 +00:00
Georg Brandl 0a24d10524 Patch #1679379: add documentation for fnmatch.translate().
(backport from rev. 54323)
2007-03-13 07:51:04 +00:00
Georg Brandl 1817f096f4 Typo fix.
(backport from rev. 54292)
2007-03-12 16:15:17 +00:00
Georg Brandl dfc2966001 Fix #1676656: \em is different from \emph...
(backport from rev. 54220)
2007-03-08 17:49:17 +00:00
Georg Brandl 4a7da9cdbc Patch #1669331: clarify shutil.copyfileobj() behavior wrt. file position.
(backport from rev. 54202)
2007-03-07 09:34:52 +00:00
Georg Brandl b535b39f77 Typo fix. 2007-03-07 09:17:42 +00:00
Andrew M. Kuchling 8bc8ab5fec Fix typo (noticed in Raymond's r54053 commit adding NamedTuple 2007-03-01 14:07:19 +00:00
Andrew M. Kuchling 366bf0d9cb Markup fix 2007-02-26 23:03:03 +00:00
Raymond Hettinger b66d33fcd0 Provide an example of defaultdict with non-zero constant factory function. 2007-02-19 19:26:16 +00:00
Georg Brandl 6b2a1a042d Add missing \versionadded.
(backport from rev. 53787)
2007-02-15 11:29:58 +00:00
Georg Brandl ee467d0ae7 Patch #1494140: Add documentation for the new struct.Struct object.
(backport from rev. 53785)
2007-02-15 11:29:08 +00:00
Georg Brandl d2bf6c0a06 Make functools.wraps() docs a bit clearer.
(backport from rev. 53783)
2007-02-15 10:38:03 +00:00
Martin v. Löwis f7f888a2f8 Bug #1658794: Remove extraneous 'this'. 2007-02-13 12:08:34 +00:00
Lars Gustäbel f5bf3b0c71 Bug #1656581: Point out that external file objects are supposed to be
at position 0. (backport from rev. 53752)
2007-02-12 09:27:10 +00:00
Georg Brandl d84f68b10f Bug #1656078: typo in in profile docs.
(backport from rev. 53697)
2007-02-09 18:48:44 +00:00
Martin v. Löwis 4b4f95d435 Update broken link. 2007-02-09 12:59:27 +00:00
Raymond Hettinger 05d59e2df7 SF: 1397711 Set docs conflated immutable and hashable 2007-02-07 21:03:24 +00:00
Georg Brandl d13eeb7fd2 Bug #1648191: typo in docs.
(backport from rev. 53603)
2007-01-30 20:21:35 +00:00
Andrew M. Kuchling 564c9f5fb0 Strengthen warning about using lock() 2007-01-24 20:08:13 +00:00
Raymond Hettinger 3b77d3d9a7 SF# 1635892: Fix docs for betavariate's input parameters . 2007-01-19 18:03:13 +00:00
Andrew M. Kuchling dfad614321 [Part of bug #1599254] Add suggestion to Mailbox docs to use Maildir, and warn user to lock/unlock mailboxes when modifying them 2007-01-17 19:56:06 +00:00
Matthias Klose 1c3d0de472 - Make the documentation match the code and the docstring 2007-01-11 10:25:45 +00:00
Vinay Sajip 73fa6b58dd Added relativeCreated to Formatter doc (has been in the system for a long time - was unaccountably left out of the docs and not noticed until now).
Documentation clarified to mention optional parameters.
Documentation omitted the additional parameter to LogRecord.__init__ which was added in 2.5. (See SF #1569622).
2007-01-08 09:36:17 +00:00
Gregory P. Smith a6e0f502ea typo fix 2007-01-05 07:22:29 +00:00
Gregory P. Smith 1a050f5f52 support linking the _bsddb extension module against BerkeleyDB 4.5
[backport of r53252]
2007-01-05 02:09:06 +00:00
Thomas Heller 28cfe299be Fix wrong markup of an argument in a method signature.
Backported from trunk.
2006-12-21 18:31:36 +00:00
Andrew M. Kuchling 3bffd289b9 Mention the os.SEEK_* constants 2006-12-21 13:41:46 +00:00
Andrew M. Kuchling a9b9ae4678 [Bug #1619680] in_dll() arguments are documented in the wrong order 2006-12-20 20:20:56 +00:00
Andrew M. Kuchling 2a927915cb Backport doc changes from rev. 53112, 53115: use 'iterable' in various
places instead of 'sequence'.
2006-12-20 20:15:08 +00:00
Andrew M. Kuchling 96e60652fa Two grammar fixes 2006-12-20 19:58:18 +00:00
Vinay Sajip e65f14fcc3 Updated documentation for findCaller() to indicate that a 3-tuple is now returned, rather than a 2-tuple. 2006-12-19 18:31:22 +00:00
Andrew M. Kuchling aa4135a45e [Bug #1618083] Add missing word; make a few grammar fixes 2006-12-18 17:13:10 +00:00
Matthias Klose f877b25008 - Fix the build of the library reference in info format. 2006-12-09 12:13:02 +00:00
Georg Brandl ec46940f3b RFE #1592899: mention string.maketrans() in docs for str.translate,
remove reference to the old regex module in the former's doc.
 (backport from rev. 52951)
2006-12-07 09:30:11 +00:00
George Yoshida 19d12d4cea Fix pickle doc typo
Patch #1608758
(backport from r52917)
2006-12-05 05:40:57 +00:00
Georg Brandl 425e2d15c5 Bug #1603789: grammatical error in Tkinter docs.
(backport from rev. 52850)
2006-11-27 18:46:47 +00:00
Georg Brandl 0c55236d39 Bug #1601630: little improvement to getopt docs
(backport from rev. 52833)
2006-11-23 09:55:10 +00:00
Neal Norwitz 6a3955e99d Fix SF #1599879, socket.gethostname should ref getfqdn directly. 2006-11-21 06:25:09 +00:00
Georg Brandl 7563191cf6 Bug #1597576: mention that the new base64 api has been introduced in py2.4.
(backport from rev. 52762)
2006-11-16 15:05:19 +00:00
Georg Brandl 8fc42c8aad Bug #1594758: wording improvement for dict.update() docs.
(backport from rev. 52733)
2006-11-11 18:32:50 +00:00
Georg Brandl c33b7488de Bug #1594742: wrong word in stringobject doc.
(backport from rev. 52731)
2006-11-11 18:29:15 +00:00
Andrew M. Kuchling 6d97478449 [Feature request #1542920] Link to wsgi.org 2006-11-10 14:39:17 +00:00
Georg Brandl 3ed5c2a277 Bug #1592533: rename variable in heapq doc example, to avoid shadowing
"sorted".
 (backport from rev. 52668)
2006-11-08 10:04:32 +00:00
Thomas Heller 27021f1cb8 Fix markup and grammatical errors. Backport from trunk 2006-11-07 18:23:14 +00:00
Skip Montanaro da65c6496d backport: note that user can control directory location even if default dir is used 2006-11-06 14:35:34 +00:00
Thomas Heller 5aafe92822 Fix code example by adding a missing import.
Fixes #1557890.

Backported from trunk.
2006-11-02 20:24:26 +00:00
Thomas Heller 906681b4d6 Replace the XXX marker in the 'Arrays and pointers' reference manual
section with a link to the tutorial sections.

Backported from trunk.
2006-11-02 19:52:43 +00:00
Neal Norwitz 7f2075a490 From SF 1557890, fix problem of using wrong type in example. 2006-10-28 22:13:22 +00:00
Georg Brandl aabdd5480c Fix nth() itertool recipe.
(backport from rev. 52497)
2006-10-28 16:04:07 +00:00
Andrew M. Kuchling d2ee30b485 Point users to the subprocess module in the docs for os.system, os.spawn*, os.popen2, and the popen2 and commands modules 2006-10-27 14:54:43 +00:00
Andrew M. Kuchling 935add1d30 [Bug #1562583] Mention the set_reuse_addr() method 2006-10-27 13:06:41 +00:00
Andrew M. Kuchling 35094a6962 [Bug #1583946] Reword description of server and issuer 2006-10-27 12:50:55 +00:00
Andrew M. Kuchling 11b69e5c52 [Bug #1585690] Note that line_num was added in Python 2.5 2006-10-27 12:18:58 +00:00
Georg Brandl ef11b1ab9c Small grammar fix, thanks Sjoerd.
(backport from rev. 52311)
2006-10-12 11:59:29 +00:00
Georg Brandl 197e8052bd Add a note to fpectl docs that it's not built by default
(bug #1556261).
 (backport from rev. 52307)
2006-10-12 11:41:15 +00:00
Georg Brandl b85509d5ef Bug #1546628: add a note about urlparse.urljoin() and absolute paths.
(backport from rev. 52303)
2006-10-12 11:14:44 +00:00
Georg Brandl bdbb9c62de Bug #1575746: fix typo in property() docs.
(backport from rev. 52293)
2006-10-12 07:38:08 +00:00
Skip Montanaro bf4358a0a9 Backport libcsv.tex bugfix from rev 52218. (SF ticket 1572471) 2006-10-08 17:51:24 +00:00
Andrew M. Kuchling d8a61bae8b Case fixes 2006-10-06 10:39:51 +00:00
Fred Drake 1d26f36897 - update links
- remove Sleepycat name now that they have been bought
2006-10-06 00:03:17 +00:00
Georg Brandl ad4e11e16d Bug #1566663: remove obsolete example from datetime docs.
(backport from rev. 52063)
2006-09-30 09:06:49 +00:00
Fred Drake 137c789e83 revise explanation of returns_unicode to reflect bool values
and to include the default value
2006-09-15 16:10:25 +00:00
Fred Drake 2e63dbe9ac - fix module name in links in formatted documentation
- minor markup cleanup
2006-09-15 14:14:55 +00:00
Georg Brandl 77aad9a09b Backport uuid doc cleanup from rev. 51883. 2006-09-15 05:26:17 +00:00
Georg Brandl fe20482a46 Correct elementtree module index entry.
(backport)
2006-09-15 05:20:57 +00:00
Georg Brandl 44850ea12a Backport rev 51866-51868 from trunk (sqlite3 documentation fixes). 2006-09-14 05:05:42 +00:00
Andrew M. Kuchling b3304c129f Fix typo in example 2006-09-08 14:06:42 +00:00
Andrew M. Kuchling 9cd0036a2b Use native SQLite types 2006-09-08 14:03:19 +00:00
Andrew M. Kuchling f36dddafc1 Explain SQLite a bit more clearly 2006-09-08 13:36:57 +00:00
Georg Brandl 08f6f476d9 Bug #1552618: change docs of dict.has_key() to reflect recommendation
to use "in".
 (backport from rev. 51740)
2006-09-05 12:45:18 +00:00
Neal Norwitz 29a5fdb7ca Fix str.rpartition(sep) when sep is not found in str.
Partially from SF patch #1551339, but also taken from head.
2006-09-05 02:21:38 +00:00
Nick Coghlan c48daf5bc4 Backport of decimal module context management updates from rev 51694 to 2.5 release branch 2006-09-03 01:08:30 +00:00
Neal Norwitz f07b590d7e Backport 51663:
Doc fix: hashlib objects don't always return a digest of 16 bytes.
2006-09-03 00:04:26 +00:00
Fred Drake 2998a1c21b - SF patch #1550263: Enhance and correct unittest docs
- various minor cleanups for improved consistency
2006-09-01 03:56:22 +00:00
Anthony Baxter ab7e5ef695 patch for documentation for recent uuid changes (from ping) 2006-08-22 07:36:06 +00:00
Thomas Heller f5af05a211 Tutorial:
Clarify somewhat how parameters are passed to functions
    (especially explain what integer means).

    Correct the table - Python integers and longs can both be used.
    Further clarification to the table comparing ctypes types, Python
    types, and C types.

Reference:

    Replace integer by C ``int`` where it makes sense.
2006-08-16 18:02:11 +00:00
Marc-André Lemburg 040f76b79c Slightly revised version of patch #1538956:
Replace UnicodeDecodeErrors raised during == and !=
compares of Unicode and other objects with a new
UnicodeWarning.

All other comparisons continue to raise exceptions.
Exceptions other than UnicodeDecodeErrors are also left
untouched.
2006-08-14 10:55:19 +00:00
Andrew M. Kuchling 30c0d1d174 Reword paragraph to clarify 2006-08-08 18:50:14 +00:00
Georg Brandl 212b587a52 Patch #1534922: correct and enhance unittest docs. 2006-08-05 06:10:54 +00:00
Andrew M. Kuchling f4152c3215 Fix mangled sentence 2006-08-04 21:10:03 +00:00
Gregory P. Smith d856ce0a1f fix typos 2006-08-04 05:17:47 +00:00
Thomas Heller 5c387f2e5d Fix a mistake. 2006-08-02 12:00:13 +00:00
Thomas Heller 6a0ce407fb A few nore words about what ctypes does.
Document that using the wrong calling convention can also raise
'ValueError: Procedure called with the wrong number of arguments'.
2006-08-02 11:35:31 +00:00
Andrew M. Kuchling b7697a50fb [Bug #848556] Remove \d* from second alternative to avoid exponential case when repeating match 2006-07-31 16:22:05 +00:00
Andrew M. Kuchling aa95fdb783 [Bug #1514540] Instead of putting the standard types in a section, put them in a chapter of their own. This means string methods will now show up in the ToC. (Should the types come before or after the functions+exceptions+constants chapter? I've put them after, for now.) 2006-07-31 16:10:24 +00:00
Andrew M. Kuchling ec3a89449e Remove reference to notation 2006-07-31 15:23:43 +00:00
Andrew M. Kuchling 17159fe26f Typo fix 2006-07-31 15:22:58 +00:00
Skip Montanaro 759c185ce0 minor tweaks 2006-07-31 03:11:11 +00:00