Commit Graph

8285 Commits

Author SHA1 Message Date
Georg Brandl d13eeb7fd2 Bug #1648191: typo in docs.
(backport from rev. 53603)
2007-01-30 20:21:35 +00:00
Fred Drake b17830e709 fix typo (extraneous ")") 2007-01-26 16:27:45 +00:00
Andrew M. Kuchling 564c9f5fb0 Strengthen warning about using lock() 2007-01-24 20:08:13 +00:00
Andrew M. Kuchling e69747c630 Update version of What's New 2007-01-22 15:14:15 +00:00
Raymond Hettinger 3b77d3d9a7 SF# 1635892: Fix docs for betavariate's input parameters . 2007-01-19 18:03:13 +00:00
Neal Norwitz fa941b9392 SF #1635217, Fix unbalanced paren 2007-01-19 05:52:46 +00:00
Georg Brandl eb68188a0d Bug #1629125: fix wrong data type (int -> Py_ssize_t) in PyDict_Next docs.
(backport from rev. 53477)
2007-01-17 21:20:01 +00:00
Georg Brandl c3df1b1392 Bug #1637967: missing //= operator in list.
(backport from rev. 53475)
2007-01-17 21:09:07 +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
Anthony Baxter a7118d3a4a update to (c) years to include 2007 2007-01-06 04:50:44 +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
Neal Norwitz d0f6729356 SF #1627373, fix typo in CarbonEvt. 2007-01-04 06:26:22 +00:00
Neal Norwitz 0c40ca6eb8 Remove a stray (old) macro name left around (I guess) 2006-12-28 04:39:54 +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
Georg Brandl 082f14b61c Patch #1592072: fix docs for return value of PyErr_CheckSignals.
(backport from rev. 52666)
2006-11-08 07:46:01 +00:00
Andrew M. Kuchling cf1e760d3e Add missing word 2006-11-07 20:39:58 +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
Andrew M. Kuchling 1121e73536 [Bug #1579796] Wrong syntax for PyDateTime_IMPORT in documentation. Reported by David Faure. 2006-10-26 19:11:06 +00:00
Andrew M. Kuchling 51c4105617 [Bug #1576348] Fix typo in example 2006-10-19 21:56:14 +00:00
Martin v. Löwis 55d3ef9c0e Mention the bdist_msi module. 2006-10-15 14:30:49 +00:00
Georg Brandl ef11b1ab9c Small grammar fix, thanks Sjoerd.
(backport from rev. 52311)
2006-10-12 11:59:29 +00:00
Georg Brandl b57ebfb7bc Bug #1560114: the Mac filesystem does have accurate information
about the case of filenames.
 (backport from rev. 52309)
2006-10-12 11:47:00 +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 8984370c06 Bug #1565919: document set types in the Language Reference.
(backport from rev. 52297)
2006-10-12 08:22:57 +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 0988904df8 Bug #1546052: clarify that PyString_FromString(AndSize) copies the
string pointed to by its parameter.
 (backport from rev. 52078)
2006-09-30 12:03:02 +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
Georg Brandl 2b48f9490f Bug #1567375: a minor logical glitch in example description.
(backport from rev. 52053)
2006-09-30 07:24:56 +00:00
George Yoshida bd42596179 SF bug #1567976 : fix typo(backport from r52048)
Since this paragraph is about exception's message attribute(2.5 feature),
I will not backport to 2.4 branch.
2006-09-30 05:22:23 +00:00
Andrew M. Kuchling a4103a3248 Make examples do error checking on Py_InitModule 2006-09-27 19:24:27 +00:00
Neal Norwitz af4e3ee365 SF Bug #1563963, add missing word and cleanup first sentance 2006-09-23 18:10:12 +00:00
Anthony Baxter 2d8697f32c Preparing for 2.5 final.
(damn, it's nice to see the line
  #define PY_VERSION              "2.5"
in patchlevel.h)
2006-09-18 06:51:50 +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
Anthony Baxter 2d4183c5f6 preparing for 2.5c2 2006-09-11 15:30:13 +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
Andrew M. Kuchling a8ed1b01a1 Rearrange example a bit, and show rpartition() when separator is not found 2006-09-05 13:11:33 +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
Neal Norwitz 38b9460b4a SF #1547931, fix typo (missing and). Backport candidate for 2.3/2.4 too 2006-09-02 02:45:43 +00:00
Georg Brandl 097bbea4b6 evalfile() should be execfile().
(backport from rev. 51677)
2006-09-01 22:30:56 +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
Andrew M. Kuchling e12b9f63ec Minor edits 2006-08-18 13:54:33 +00:00
Georg Brandl 1e8feed293 Typo in tp_clear docs.
(backport from rev. 51368)
2006-08-18 07:35:53 +00:00
Georg Brandl 595d9b6bc6 Bug #1541682: Fix example in the "Refcount details" API docs.
Additionally, remove a faulty example showing PySequence_SetItem applied
to a newly created list object and add notes that this isn't a good idea.
 (backport from rev. 51364)
2006-08-18 07:28:03 +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
Andrew M. Kuchling 213e764d38 Update bug/patch counts 2006-08-16 14:18:23 +00:00
Andrew M. Kuchling ddf37888b8 Link to docs; remove an XXX comment 2006-08-16 13:51:32 +00:00
Andrew M. Kuchling 115ea43bff Bump document version to 1.0; remove pystone paragraph 2006-08-16 13:41:52 +00:00
Andrew M. Kuchling efd68c789e Add UnicodeWarning 2006-08-16 13:22:20 +00:00
Anthony Baxter b409666e8c preparing for 2.5c1 2006-08-16 03:42:26 +00:00
Georg Brandl 4873fb2bac Improve markup in PyUnicode_RichCompare. 2006-08-14 12:36:06 +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
Neal Norwitz bfa5f0bb5d SF bug #1539336, distutils example code missing 2006-08-13 00:20:49 +00:00
Neal Norwitz 8a87f5d37e Patch #1538606, Patch to fix __index__() clipping.
I modified this patch some by fixing style, some error checking, and adding
XXX comments.  This patch requires review and some changes are to be expected.
I'm checking in now to get the greatest possible review and establish a
baseline for moving forward.  I don't want this to hold up release if possible.
2006-08-12 17:03:09 +00:00
Tim Peters 4643c2fda1 Followup to bug #1069160.
PyThreadState_SetAsyncExc():  internal correctness changes wrt
refcount safety and deadlock avoidance.  Also added a basic test
case (relying on ctypes) and repaired the docs.
2006-08-10 22:45:34 +00:00
Andrew M. Kuchling 98c048041d Reindent code 2006-08-09 14:06:19 +00:00
Andrew M. Kuchling 58aa6f70a1 Add missing 'self' parameters 2006-08-09 14:05:35 +00:00
Andrew M. Kuchling 13300f2bfa [Patch #1534027] Add notes on locale module changes 2006-08-09 13:57:05 +00:00
Andrew M. Kuchling b71366081f [Bug #1536021] Mention __hash__ change 2006-08-09 13:03:41 +00:00
Martin v. Löwis ab2f8f7bd5 __hash__ may now return long int; the final hash
value is obtained by invoking hash on the long int.
Fixes #1536021.
2006-08-09 07:57:39 +00:00
Georg Brandl 7572f0322a ``str`` is now the same object as ``types.StringType``. 2006-08-08 20:48:10 +00:00
Georg Brandl 7f719c5edf Bug #1536660: separate two words. 2006-08-08 20:13:13 +00:00
Georg Brandl 6c223fe796 Bug #1536828: typo: TypeType should have been StringType. 2006-08-08 20:11:22 +00:00
Andrew M. Kuchling 4f71b55040 Bump version number 2006-08-08 19:00:34 +00:00
Andrew M. Kuchling a9771307b5 'Other changes' section now has only one item; move the item elsewhere and remove the section 2006-08-08 19:00:14 +00:00
Andrew M. Kuchling 88eb45fa1e Move obmalloc item into C API section 2006-08-08 18:56:08 +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
Anthony Baxter 5d32a9f188 pre-release machinations 2006-08-02 07:43:09 +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
Georg Brandl fbf969928f Fix function name. 2006-07-31 16:00:34 +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
Andrew M. Kuchling 04c897a2a9 Mention csv newline changes 2006-07-31 13:18:27 +00:00
Andrew M. Kuchling 4bcfe53e29 Add PyErr_WarnEx() 2006-07-31 12:52:26 +00:00
Andrew M. Kuchling 555ac45b20 Document PyErr_WarnEx. (Bad Neal! No biscuit!)
Is the explanation of the 'stacklevel' parameter clear?  Please feel free
to edit it.

I don't have LaTeX installed on this machine, so haven't verified that the
markup is correct.  Will check tonight, or maybe the automatic doc build will
tell me.
2006-07-31 12:39:05 +00:00
Andrew M. Kuchling 43bae4144b Add refcounts for PyErr_WarnEx 2006-07-31 12:20:24 +00:00
Skip Montanaro 759c185ce0 minor tweaks 2006-07-31 03:11:11 +00:00
Skip Montanaro 08bbccf369 minor tweaks 2006-07-31 03:09:45 +00:00
Andrew McNamara 10183b8e40 Redo the comment about the 2.5 change in quoted-newline handling. 2006-07-31 02:27:48 +00:00
Georg Brandl 5b654ea774 Bug #1531349: right <-> left glitch in __rop__ description. 2006-07-30 20:18:51 +00:00
George Yoshida c7605270b4 Rename struct.pack_to to struct.pack_into as changed in revision 46642. 2006-07-30 16:37:37 +00:00
Georg Brandl e34ac7ce7a Bug #1002398: The documentation for os.path.sameopenfile now correctly
refers to file descriptors, not file objects.
2006-07-30 11:07:23 +00:00
Georg Brandl ad6911bd62 Clarify that __op__ methods must return NotImplemented if they don't support the operation. 2006-07-30 10:53:32 +00:00
Fred Drake 33c3e29fce - remove yet another reference to how commonly Tkinter is (thought to be) used
- fix an internal section reference
2006-07-30 05:55:39 +00:00
Fred Drake 21731118af remove possibly-outdated comment on what GUI toolkit is most commonly used;
it is hard to know whether this is right, and it does not add valuable reference information
at any rate
2006-07-30 05:49:49 +00:00
Fred Drake c3c805e8b2 update information on wxPython, from Robin Dunn 2006-07-30 05:41:28 +00:00
Fred Drake e0d4aecfc2 lots of markup nits, most commonly Unix/unix --> \UNIX 2006-07-30 03:03:43 +00:00
Andrew M. Kuchling ad416d056f [Bug #793553] Correct description of keyword arguments for SSL authentication 2006-07-30 00:37:56 +00:00
Fred Drake d457a97beb markup cleanups 2006-07-29 23:34:57 +00:00
Andrew M. Kuchling 2d5c8e3bb1 Fix case for 'Unix' 2006-07-29 21:30:21 +00:00
Andrew M. Kuchling b9a79c95dc Follow TeX's conventions for hyphens 2006-07-29 21:27:12 +00:00
Fred Drake a650fb3d6f fix minor markup error that introduced extra punctuation 2006-07-29 20:21:25 +00:00
Skip Montanaro abd51a3585 Add a comment to the csv reader documentation that explains why the
treatment of newlines changed in 2.5.  Pulled almost verbatim from a comment
by Andrew McNamara in <http://python.org/sf/1465014>.
2006-07-29 20:06:05 +00:00
Fred Drake 45540b0922 SF bug #1193966: Weakref types documentation misplaced
The information about supporting weakrefs with types defined in C extensions
is moved to the Extending & Embedding manual.  Py_TPFLAGS_HAVE_WEAKREFS is
no longer mentioned since it is part of Py_TPFLAGS_DEFAULT.
2006-07-29 20:04:42 +00:00
Andrew M. Kuchling 9964fdb466 [Patch #1068277] Clarify that os.path.exists() can return False depending on permissions. Fred approved committing this patch in December 2004! 2006-07-29 19:50:37 +00:00
Andrew M. Kuchling a40191c305 [Patch #1490989 from Skip Montanaro] Mention debugging builds in the API documentation. I've changed Skip's patch to point to Misc/SpecialBuilds and fiddled with the markup a bit. 2006-07-29 19:24:04 +00:00
Fred Drake 897afc43ad emphasize and oddball nuance of LaTeX comment syntax 2006-07-29 19:14:10 +00:00
Fred Drake 4a847888a7 document the footnote usage pattern 2006-07-29 19:09:01 +00:00
Fred Drake 84608f0c67 make the reference to older versions of the documentation a link
to the right page on python.org
2006-07-29 18:33:29 +00:00
Andrew M. Kuchling 956597f4ef Reorganize the docs for 'file' and 'open()' after some discussion with Fred.
We want to encourage users to write open() when opening a file, but
open() was described with a single paragraph and
'file' had lots of explanation of the mode and bufsize arguments.

I've shrunk the description of 'file' to cross-reference to the 'File
objects' section, and to open() for an explanation of the arguments.

open() now has all the paragraphs about the mode string.  The bufsize
argument was moved up so that it isn't buried at the end; now there's
1 paragraph on mode, 1 on bufsize, and then 3 more on mode.  Various
other edits and rearrangements were made in the process.

It's probably best to read the final text and not to try to make sense
of the diffs.
2006-07-29 18:14:07 +00:00
Fred Drake fbdeaad069 expunge the xmlcore changes:
41667, 41668 - initial switch to xmlcore
  47044        - mention of xmlcore in What's New
  50687        - mention of xmlcore in the library reference

re-apply xmlcore changes to xml:
  41674        - line ending changes (re-applied manually), directory props
  41677        - add cElementTree wrapper
  41678        - PSF licensing for etree
  41812        - whitespace normalization
  42724        - fix svn:eol-style settings
  43681, 43682 - remove Python version-compatibility cruft from minidom
  46773        - fix encoding of \r\n\t in attr values in saxutils
  47269        - added XMLParser alias for cElementTree compatibility

additional tests were added in Lib/test/test_sax.py that failed with
the xmlcore changes; these relate to SF bugs #1511497, #1513611
2006-07-29 16:56:15 +00:00
Andrew M. Kuchling c032ee939b Set bug/patch count. Take a bow, everyone! 2006-07-29 16:08:40 +00:00