Commit Graph

4175 Commits

Author SHA1 Message Date
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 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 e49741d412 [Bug #1528258] Mention that the 'data' argument can be None.
The constructor docs referred the reader to the add_data() method's docs,
but they weren't very helpful.  I've simply copied an earlier explanation
of 'data' that's more useful.
2006-07-29 15:57:08 +00:00
Matt Fleming aab30d0f08 Fix typo 2006-07-29 15:55:30 +00:00
Andrew M. Kuchling b9d7e04880 [Bug #1530382] Document SSL.server(), .issuer() methods 2006-07-29 15:35:21 +00:00
Andrew M. Kuchling 7092f4ce9f [Bug #1519571] Document some missing functions: setup(), title(), done() 2006-07-29 14:42:48 +00:00
Andrew M. Kuchling dafb1e59c9 [Bug #1529157] Mention raw_input() and input(); while I'm at it, reword the description a bit 2006-07-29 14:21:15 +00:00
Andrew M. Kuchling 3ec3f78c8a Reword paragraph to match the order of the subsequent sections 2006-07-29 14:08:15 +00:00
Andrew M. Kuchling 144691cfd8 Update URL 2006-07-29 14:04:47 +00:00
Andrew M. Kuchling 35f64c12d3 Add example 2006-07-29 13:56:48 +00:00
Georg Brandl 9fd21e31b6 Bug #835255: The "closure" argument to new.function() is now documented. 2006-07-29 08:51:21 +00:00
Phillip J. Eby f7575d0cb7 Bug #1529871: The speed enhancement patch #921466 broke Python's compliance
with PEP 302.  This was fixed by adding an ``imp.NullImporter`` type that is
used in ``sys.path_importer_cache`` to cache non-directory paths and avoid
excessive filesystem operations during imports.
2006-07-28 21:12:07 +00:00
Andrew M. Kuchling 39d7739e6c Add example. Should I propagate this example to all the other DBM-ish modules, too? 2006-07-28 12:48:07 +00:00
Andrew M. Kuchling 1d69a7013f Don't overwrite built-in name; add some blank lines for readability 2006-07-28 12:45:55 +00:00
Andrew M. Kuchling bd468103e0 Add example 2006-07-28 12:33:19 +00:00
Andrew M. Kuchling 4036f43cac Add example 2006-07-28 12:32:43 +00:00
Andrew M. Kuchling 984b075978 Typo fix 2006-07-28 12:18:22 +00:00
Tim Peters 750c4420a8 Live with that "the hardware address" is an ill-defined
concept, and that different ways of trying to find "the
hardware address" may return different results.  Certainly
true on both of my Windows boxes, and in different ways
(see whining on python-dev).
2006-07-28 04:51:59 +00:00
Barry Warsaw 00decd7835 Patch #1520294: Support for getset and member descriptors in types.py,
inspect.py, and pydoc.py.  Specifically, this allows for querying the type of
an object against these built-in C types and more importantly, for getting
their docstrings printed in the interactive interpreter's help() function.

This patch includes a new built-in module called _types which provides
definitions of getset and member descriptors for use by the types.py module.
These types are exposed as types.GetSetDescriptorType and
types.MemberDescriptorType.  Query functions are provided as
inspect.isgetsetdescriptor() and inspect.ismemberdescriptor().  The
implementations of these are robust enough to work with Python implementations
other than CPython, which may not have these fundamental types.

The patch also includes documentation and test suite updates.

I commit these changes now under these guiding principles:

1. Silence is assent.  The release manager has not said "no", and of the few
   people that cared enough to respond to the thread, the worst vote was "0".

2. It's easier to ask for forgiveness than permission.

3. It's so dang easy to revert stuff in svn, that you could view this as a
   forcing function. :)

Windows build patches will follow.
2006-07-27 23:43:15 +00:00
Andrew M. Kuchling fc0e61d9b6 Add example 2006-07-27 22:49:54 +00:00
Andrew M. Kuchling 752e28ad9f Add example 2006-07-27 22:49:38 +00:00
Andrew M. Kuchling 4b6d53780d Reword paragraph 2006-07-27 22:40:05 +00:00
Andrew M. Kuchling cff784caa7 If binhex is higher-level than binascii, it should come first in the chapter 2006-07-27 19:12:49 +00:00
Andrew M. Kuchling 40b35aa5cc Mention base64 module; rewrite last sentence to be more positive 2006-07-27 19:11:07 +00:00
Andrew M. Kuchling cbe801697b Add punctuation mark; add some examples 2006-07-27 19:07:29 +00:00
Andrew M. Kuchling f60eeb1738 Update URL; add example 2006-07-27 18:53:33 +00:00
Andrew M. Kuchling 623005e94a Add missing word 2006-07-27 18:42:41 +00:00
Andrew M. Kuchling 5ee6616528 Typo fix ('publically' is rare, poss. non-standard) 2006-07-27 18:41:21 +00:00
Andrew M. Kuchling 9dd8dc3fee Add example 2006-07-27 18:37:33 +00:00
Greg Ward 48fae7acd2 Resync optparse with Optik 1.5.3: minor tweaks for/to tests. 2006-07-23 16:05:51 +00:00
Barry Warsaw b110bad2d9 More RFC 2231 improvements for the email 4.0 package. As Mark Sapiro rightly
points out there are really two types of continued headers defined in this
RFC (i.e. "encoded" parameters with the form "name*0*=" and unencoded
parameters with the form "name*0="), but we were were handling them both the
same way and that isn't correct.

This patch should be much more RFC compliant in that only encoded params are
%-decoded and the charset/language information is only extract if there are
any encoded params in the segments.  If there are no encoded params then the
RFC says that there will be no charset/language parts.

Note however that this will change the return value for Message.get_param() in
some cases.  For example, whereas before if you had all unencoded param
continuations you would have still gotten a 3-tuple back from this method
(with charset and language == None), you will now get just a string.  I don't
believe this is a backward incompatible change though because the
documentation for this method already indicates that either return value is
possible and that you must do an isinstance(val, tuple) check to discriminate
between the two.  (Yeah that API kind of sucks but we can't change /that/
without breaking code.)

Test cases, some documentation updates, and a NEWS item accompany this patch.
2006-07-21 14:51:07 +00:00
Fred Drake 3fda93604c markup fix 2006-07-20 20:11:57 +00:00
Vinay Sajip 9325ba6df4 Updated documentation for TimedRotatingFileHandler relating to how rollover files are named. The previous documentation was wrongly the same as for RotatingFileHandler. 2006-07-20 16:28:39 +00:00
Brett Cannon caebe22038 Fix bug #1520914. Starting in 2.4, time.strftime() began to check the bounds
of values in the time tuple passed in.  Unfortunately people came to rely on
undocumented behaviour of setting unneeded values to 0, regardless of if it was
within the valid range.  Now those values force the value internally to the
minimum value when 0 is passed in.
2006-07-18 04:41:36 +00:00
Fred Drake 83fa22f564 document xmlcore (still minimal; needs mention in each of the xml.* modules)
SF bug #1504456 (partial)
2006-07-17 05:47:52 +00:00
Fredrik Lundh 76e268bb62 typo 2006-07-14 21:45:48 +00:00
Thomas Heller b69a3c2bda Updates for the ctypes documentation. 2006-07-14 18:22:50 +00:00
Peter Astrand 7d1d43630e Bug #1223937: CalledProcessError.errno -> CalledProcessError.returncode. 2006-07-14 14:04:45 +00:00
Thomas Heller 76c5af6216 Fix the wrong description of LibraryLoader.LoadLibrary, and document
the DEFAULT_MODE constant.
2006-07-12 14:25:18 +00:00
Martin v. Löwis 06c68b800c Patch #1519566: Remove unused _tofill member.
Make begin_fill idempotent.
Update demo2 to demonstrate filling of concave shapes.
2006-07-10 22:11:28 +00:00
Tim Peters 32a8361f2d After approval from Anthony, merge the tim-current_frames
branch into the trunk.  This adds a new sys._current_frames()
function, which returns a dict mapping thread id to topmost
thread stack frame.
2006-07-10 21:08:24 +00:00
Neal Norwitz 56640df6c3 Patch #1504046: Add documentation for xml.etree.
/F wrote the text docs, Englebert Gruber massaged it to latex and I
did some more massaging to try and improve the consistency and
fix some name mismatches between the declaration and text.
2006-07-10 02:36:41 +00:00
Georg Brandl b6b175229b Fix RFC number. 2006-07-07 08:15:12 +00:00
Nick Coghlan 2bfe3a9dbf Cover ImportWarning, PendingDeprecationWarning and simplefilter() in the warnings module docs 2006-07-06 13:41:34 +00:00
Nick Coghlan 56829d5b4a Revert the __module_name__ changes made in rev 47142. We'll revisit this in Python 2.6 2006-07-06 12:53:04 +00:00
Thomas Heller b979b35f70 Document the changes in svn revision 47263, from patch #1517790. 2006-07-06 09:11:22 +00:00
Thomas Heller f40aed930a Document the Struture and Union constructors. 2006-07-06 08:58:40 +00:00
Georg Brandl d41f4ce0c8 no need to elaborate "string". 2006-07-05 15:50:05 +00:00
Georg Brandl f41beacecb Patch #1517490: fix glitches in filter() docs. 2006-07-05 14:18:45 +00:00
Andrew M. Kuchling 2eda1b78f9 [Bug #1511911] Clarify description of optional arguments to sorted()
by improving the xref to the section on lists, and by
   copying the explanations of the arguments (with a slight modification).
2006-07-03 14:16:09 +00:00
Andrew M. Kuchling f896795103 [Bug #1515932] Clarify description of slice assignment 2006-07-03 14:07:30 +00:00
Martin v. Löwis 82c276ea33 Document functions added in 2.3 and 2.5. 2006-07-03 11:12:06 +00:00
Fred Drake 6f42dfce7c - consistency nit: always include "()" in \function and \method
(*should* be done by the presentation, but that requires changes all over)
- avoid spreading the __name meme
2006-06-30 19:29:25 +00:00
Georg Brandl 348b7c8304 Document decorator usage of property. 2006-06-30 18:47:56 +00:00
Skip Montanaro 4ef256cab0 add string methods to index 2006-06-29 19:20:09 +00:00
Andrew M. Kuchling ecfec78b7b [Bug #1508766] Add docs for uuid module; this puts the module in the 'Internet Protocols' section. Arguably this module could also have gone in the chapters on strings or encodings, maybe even the crypto chapter. Fred, please move if you see fit. 2006-06-28 14:27:21 +00:00
Andrew M. Kuchling 146d3924b0 [Bug #1508766] Add docs for uuid module; docs written by George Yoshida, with minor rearrangements by me. 2006-06-28 14:25:20 +00:00
Nick Coghlan 999a336ad7 Make full module name available as __module_name__ even when __name__ is set to something else (like '__main__') 2006-06-28 10:41:47 +00:00
Thomas Heller 978ec9a89f Small fixes, mostly in the markup. 2006-06-22 19:07:36 +00:00
Thomas Heller 066769c307 Fix typos.
Fix doctest example.
Mention in the tutorial that 'errcheck' is explained in the ref manual.
Use better wording in some places.
Remoce code examples that shouldn't be in the tutorial.
Remove some XXX notices.
2006-06-18 21:27:04 +00:00
George Yoshida 3f1f7bec74 Update url.
Old url returned status code:301 Moved permanently.
2006-06-17 16:39:13 +00:00
Fred Drake fab461a4b5 SF patch 1504676: Make sgmllib char and entity references pluggable
(implementation/tests contributed by Sam Ruby)
2006-06-16 23:45:06 +00:00
Gregory P. Smith b526a29dbc minor documentation cleanup. mention the bsddb.db interface explicitly by name. 2006-06-15 09:23:52 +00:00
Ronald Oussoren 143cefb846 Patch #1446489 (zipfile: support for ZIP64) 2006-06-15 08:14:18 +00:00
Thomas Heller f1435100cf Document paramflags. 2006-06-14 09:09:08 +00:00
Thomas Heller bcae6222e5 Write more docs. 2006-06-14 07:08:38 +00:00
Tim Peters 43898b4f64 SequenceMatcher.get_matching_blocks(): This now guarantees that
adjacent triples in the result list describe non-adjacent matching
blocks.  That's _nice_ to have, and Guido said he wanted it.

Not a bugfix candidate:  Guido or not ;-), this changes visible
endcase semantics (note that some tests had to change), and
nothing about this was documented before.  Since it was working
as designed, and behavior was consistent with the docs, it wasn't
"a bug".
2006-06-14 04:09:25 +00:00
Gerhard Häring 5d7c290b7b Updated documentation for pysqlite 2.3.0 API. 2006-06-13 22:53:48 +00:00
Thomas Heller b66902fc90 More docs for ctypes. 2006-06-13 20:18:43 +00:00
Andrew MacIntyre 9291332de1 Patch #1454481: Make thread stack size runtime tunable.
Heavily revised, comprising revisions:
46640 - original trunk revision (backed out in r46655)
46647 - markup fix (backed out in r46655)
46692:46918 merged from branch aimacintyre-sf1454481

branch tested on buildbots (Windows buildbots had problems
not related to these changes).
2006-06-13 15:04:24 +00:00
Nick Coghlan f0d02fbb9a The site module documentation also described the Windows behaviour incorrectly. 2006-06-12 08:27:13 +00:00
Greg Ward d1c797e624 SF #1366250: optparse docs: fix inconsistency in variable name; minor tweaks. 2006-06-11 14:42:41 +00:00
Neal Norwitz a754a229b4 Add versionadded to doc 2006-06-11 05:45:47 +00:00
Greg Ward 7f54740c4d Bug #1361643: fix textwrap.dedent() so it handles tabs appropriately,
i.e. do *not* expand tabs, but treat them as whitespace that is not
equivalent to spaces.  Add a couple of test cases.  Clarify docs.
2006-06-11 00:40:49 +00:00
Thomas Heller 82578c895c New docs for ctypes. 2006-06-10 20:29:34 +00:00
Greg Ward c5221e157e Sync with Optik docs (rev 518):
* restore "Extending optparse" section
  * document ALWAYS_TYPED_ACTIONS (SF #1449311)
2006-06-10 16:40:01 +00:00
Georg Brandl 242508160e RFE #1491485: str/unicode.endswith()/startswith() now accept a tuple as first argument. 2006-06-09 18:45:48 +00:00
Phillip J. Eby 5cf565ddd1 Import wsgiref into the stdlib, as of the external version 0.1-r2181. 2006-06-09 16:40:18 +00:00
Nick Coghlan 676725db92 Add functools.update_wrapper() and functools.wraps() as described in PEP 356 2006-06-08 13:54:49 +00:00
Andrew M. Kuchling 06c5c8a4d3 Typo fix 2006-06-08 11:56:44 +00:00
Andrew M. Kuchling e275d3d4ce Mention other placeholders 2006-06-07 17:04:01 +00:00
Andrew M. Kuchling 12238d72a8 Add an SQLite introduction, taken from the 'What's New' text 2006-06-07 13:55:33 +00:00
Tim Peters dba6318ae6 On python-dev Thomas Heller said these were committed
by mistake in rev 46693, so reverting this part of
rev 46693.
2006-06-06 15:52:35 +00:00
Thomas Heller 56dab85022 Specify argtypes for all test functions. Maybe that helps on strange ;-) architectures 2006-06-06 15:34:18 +00:00
Tim Peters bf0400abe9 Remove doctest.testmod's deprecated (in 2.4) `isprivate`
argument.  A lot of hair went into supporting that!
2006-06-05 01:43:03 +00:00
Tim Peters 28eeefe566 Revert revisions:
46640 Patch #1454481:  Make thread stack size runtime tunable.
46647 Markup fix

The first is causing many buildbots to fail test runs, and there
are multiple causes with seemingly no immediate prospects for
repairing them.  See python-dev discussion.

Note that a branch can (and should) be created for resolving these
problems, like

svn copy svn+ssh://svn.python.org/python/trunk -r46640 svn+ssh://svn.python.org/python/branches/NEW_BRANCH

followed by merging rev 46647 to the new branch.
2006-06-04 23:52:47 +00:00
George Yoshida 67966bed72 Markup fix 2006-06-04 17:17:25 +00:00
Andrew MacIntyre 6539d2d3c7 Patch #1454481: Make thread stack size runtime tunable. 2006-06-04 12:31:09 +00:00
Andrew M. Kuchling 4094b3d08c Minor rewording 2006-06-03 18:43:24 +00:00
Andrew M. Kuchling 27ca711d20 [Bug #1441864] Clarify description of 'data' argument 2006-06-03 18:41:28 +00:00