Commit Graph

7973 Commits

Author SHA1 Message Date
Georg Brandl a89dbec257 Patch #1492218: document None being a constant. 2006-05-26 20:14:47 +00:00
Thomas Heller cc7570fd90 Write more docs. 2006-05-26 19:43:45 +00:00
Georg Brandl e001816dff Exception isn't the root of all exception classes anymore. 2006-05-26 19:04:47 +00:00
Andrew M. Kuchling afe6598732 Add rpartition() and path caching 2006-05-26 18:41:18 +00:00
Fredrik Lundh 9c0e9c089c needspeed: rpartition documentation, tests, and a bug fixes.
feel free to add more tests and improve the documentation.
2006-05-26 18:24:15 +00:00
Thomas Heller 2d6c5a868a Reordered, and wrote more docs. 2006-05-26 17:47:40 +00:00
Thomas Heller 69bfaab304 Write some docs. 2006-05-26 17:18:33 +00:00
Thomas Heller ada638bf91 For now, I gave up with automatic conversion of reST to Python-latex,
so I'm writing this in latex now.

Skeleton for the ctypes reference.
2006-05-26 16:42:44 +00:00
Andrew M. Kuchling c6f5c871b9 Typo fix 2006-05-26 14:04:19 +00:00
Andrew M. Kuchling 230c3e1bc0 Add buffer support for struct, socket 2006-05-26 14:03:41 +00:00
Andrew M. Kuchling ad0cb65fca Add str.partition() 2006-05-26 12:39:48 +00:00
Andrew M. Kuchling a0fcf502df Typo fixes 2006-05-26 12:01:44 +00:00
Georg Brandl 0c93ff6709 Clarify docs for str.partition(). 2006-05-26 09:05:54 +00:00
Fredrik Lundh 06a69dd8ff needforspeed: partition implementation, part two.
feel free to improve the documentation and the docstrings.
2006-05-26 08:54:28 +00:00
Georg Brandl 485dbd105f Add a x-ref to newer calling APIs. 2006-05-25 21:11:56 +00:00
Georg Brandl 9d67d5e9f7 Someone seems to just have copy-pasted the docs of
tp_compare to tp_richcompare ;)
2006-05-25 20:28:10 +00:00
Fred Drake 61bbe6c37c fix broken links in PDF
(SF patch #1281291, contributed by Rory Yorke)
2006-05-25 02:42:25 +00:00
Andrew M. Kuchling 3cdf24bc99 Minor edits; add an item 2006-05-25 00:23:03 +00:00
Andrew M. Kuchling 70bd199fa4 Add item 2006-05-23 19:32:35 +00:00
Andrew M. Kuchling 150faff195 Add two items 2006-05-23 19:29:38 +00:00
Andrew M. Kuchling 3e134a5960 Use 'speed' instead of 'performance', because I agree with the argument
at http://zestyping.livejournal.com/193260.html that 'erformance' really means
something more general.
2006-05-23 12:49:35 +00:00
Andrew M. Kuchling 1cdace4294 Mention string improvements 2006-05-23 12:47:01 +00:00
Andrew M. Kuchling c602723e45 Add some items; mention the sprint 2006-05-23 12:44:36 +00:00
Georg Brandl 658d513328 PyErr_NewException now accepts a tuple of base classes as its
"base" parameter.
2006-05-23 11:17:21 +00:00
George Yoshida 00f6e1905a Apply patch #1492255 from Mike Foord. 2006-05-21 04:40:32 +00:00
George Yoshida c120a6d897 Fix the TeX compile error. 2006-05-21 04:22:59 +00:00
Andrew M. Kuchling 1e9f574a18 Minor edits 2006-05-20 19:25:16 +00:00
George Yoshida b688b6c30a Apply patch #1492147 from Mike Foord. 2006-05-20 18:07:26 +00:00
George Yoshida 5c6a5ecddf - Add 'as' and 'with' as new keywords in 2.5.
- Regenerate keyword lists with reswords.py.
2006-05-20 16:29:14 +00:00
George Yoshida 6fffa5e865 - markup fix
- add clarifying words
2006-05-20 15:36:19 +00:00
Andrew M. Kuchling e04fe8c62e Typo fix; add clarifying word 2006-05-19 00:03:55 +00:00
Georg Brandl 007a382a4d Bug #1490688: properly document %e, %f, %g format subtleties. 2006-05-18 07:20:05 +00:00
Georg Brandl 7b90e168f3 Bug #1462152: file() now checks more thoroughly for invalid mode
strings and removes a possible "U" before passing the mode to the
C library function.
2006-05-18 07:01:27 +00:00
Georg Brandl b89316fdbf Patch #1180296: improve locale string formatting functions 2006-05-17 15:51:16 +00:00
Georg Brandl d419a93fbc Apply patch #1489784 from Michael Foord. 2006-05-17 14:11:36 +00:00
Georg Brandl c01b6aeede Remove misleading comment about type-class unification. 2006-05-17 14:06:07 +00:00
Tim Peters 1b38357094 Text files missing the SVN eol-style property. 2006-05-16 23:24:08 +00:00
George Yoshida 0c8d7b0f3f Document ImportWarning 2006-05-16 18:26:10 +00:00
George Yoshida 2f6ce536ab Mention that Exception is now a subclass of BaseException.
Remove a sentence that says that BaseException inherits from BaseException.
(I guess this is just a copy & paste mistake.)
2006-05-16 18:07:00 +00:00
Andrew M. Kuchling c0a0decd54 PEP 243 has been withdrawn, so don't refer to it any more.
The PyPI upload material has been moved into the section on PEP314.
2006-05-16 16:27:31 +00:00
Andrew M. Kuchling d779b353fa Add item 2006-05-16 16:11:54 +00:00
Georg Brandl 8d3342b489 Patch #1435422: zlib's compress and decompress objects now have a
copy() method.
2006-05-16 07:38:27 +00:00
Tim Peters e6d9506611 Typo repair. 2006-05-13 23:31:05 +00:00
Tim Peters 8931ff1f67 Teach PyString_FromFormat, PyErr_Format, and PyString_FromFormatV
about "%u", "%lu" and "%zu" formats.

Since PyString_FromFormat and PyErr_Format have exactly the same rules
(both inherited from PyString_FromFormatV), it would be good if someone
with more LaTeX Fu changed one of them to just point to the other.
Their docs were way out of synch before this patch, and I just did a
mass copy+paste to repair that.

Not a backport candidate (this is a new feature).
2006-05-13 23:28:20 +00:00
George Yoshida 90df06e5e2 Add \exception markup 2006-05-13 06:53:31 +00:00
Gerhard Häring 2b161d9038 Integrated the rest of the pysqlite reference manual into the Python
documentation. Ready to be reviewed and improved upon.
2006-05-12 23:49:49 +00:00
George Yoshida 8f505aed46 Duplicated description about the illegal continue usage can be found in nearly the same place.
They are same, so keep the original one and remove the later-added one.
2006-05-12 17:25:26 +00:00
George Yoshida 159a1160c1 At first there were 6 steps, but one was removed after that. 2006-05-12 16:40:11 +00:00
Tim Peters b06d28c160 SF patch #1473132: Improve docs for tp_clear and tp_traverse,
by Collin Winter.

Bugfix candidate (but I'm not going to bother).
2006-05-12 01:57:59 +00:00
Andrew M. Kuchling 7cadf59e14 typo fix 2006-05-11 16:32:24 +00:00
George Yoshida 4917c34b26 Grammar fix 2006-05-11 15:53:27 +00:00
Martin v. Löwis 879768dd97 Change WindowsError to carry the Win32 error code in winerror,
and the DOS error code in errno. Revert changes where
WindowsError catch blocks unnecessarily special-case OSError.
2006-05-11 13:28:43 +00:00
Georg Brandl dd0c312703 Fix two small errors in argument lists. 2006-05-10 20:09:23 +00:00
Andrew M. Kuchling 356af466c8 Clarify description of exception handling 2006-05-10 17:19:04 +00:00
Georg Brandl 38c6a22f38 Patch #1484695: Update the tarfile module to version 0.8. This fixes
a couple of issues, notably handling of long file names using the
GNU LONGNAME extension.
2006-05-10 16:26:03 +00:00
Georg Brandl f8d9a97ba2 Bug #1484978: curses.panel: clarify that Panel objects are destroyed on garbage collection. 2006-05-10 16:11:44 +00:00
Georg Brandl b1582557aa Bug #1485447: subprocess: document that the "cwd" parameter isn't used to find the executable. Misc. other markup fixes. 2006-05-10 16:09:03 +00:00
Georg Brandl e7d9539eba Bug #1482988: indicate more prominently that the Stats class is in the pstats module. 2006-05-10 15:59:06 +00:00
Andrew M. Kuchling 0901965134 Minor language edit 2006-05-07 17:14:53 +00:00
Andrew M. Kuchling fb10858fe7 [Patch #1479977] Revised version of urllib2 HOWTO, edited by John J. Lee 2006-05-07 17:12:12 +00:00
George Yoshida ce5933f582 Use \versionchanged for the feature change 2006-05-06 14:16:51 +00:00
George Yoshida d3d8ecda15 describe optional arguments for DocFileSuite 2006-05-06 13:09:45 +00:00
Nick Coghlan d8accb32a5 Get rid of a couple more context object references, fix some markup and clarify what happens when a generator context function swallows an exception. 2006-05-03 13:17:49 +00:00
Nick Coghlan afd5e63e24 Finish bringing SVN into line with latest version of PEP 343 by getting rid of all remaining references to context objects that I could find. Without a __context__() method context objects no longer exist. Also get test_with working again, and adopt a suggestion from Neal for decimal.Context.get_manager() 2006-05-03 13:02:47 +00:00
Martin v. Löwis a3a13298b2 Correct some formulations, fix XXX comments. 2006-05-03 04:52:04 +00:00
Tim Peters 4511a713d5 Whitespace normalization. 2006-05-03 04:46:14 +00:00
Fred Drake 3053667d09 fix up whitespace in prompt strings 2006-05-03 02:29:39 +00:00
Fred Drake 5f1cca0a1d one more place to avoid extra markup (how many will there be?) 2006-05-03 02:29:09 +00:00
Fred Drake 2de7a35e9a one more place to avoid extra markup 2006-05-03 02:27:40 +00:00
Fred Drake 6b07be9d29 at least comment on why curly-quotes are not enabled 2006-05-03 02:12:47 +00:00
Fred Drake f25fa6ddb9 avoid ugly markup based on the unfortunate conversions of ">>" and "<<" to
guillemets; no need for magic here
2006-05-03 02:04:40 +00:00
Fred Drake f863609cd6 tell LaTeX2HTML to:
- use UTF-8 output
- not mess with the >>> prompt!
2006-05-03 01:48:24 +00:00
Fred Drake e10b21bd6f remove unnecessary assignment 2006-05-03 01:46:52 +00:00
Andrew M. Kuchling f322d68327 Update context manager section for removal of __context__ 2006-05-02 22:47:49 +00:00
Armin Rigo a71fd71c3e Documentation bug: PySet_Pop() returns a new reference (because the
caller becomes the owner of that reference).
2006-05-02 19:52:32 +00:00
Guido van Rossum da5b701aee Get rid of __context__, per the latest changes to PEP 343 and python-dev
discussion.
There are two places of documentation that still mention __context__:
Doc/lib/libstdtypes.tex -- I wasn't quite sure how to rewrite that without
spending a whole lot of time thinking about it; and whatsnew, which Andrew
usually likes to change himself.
2006-05-02 19:47:52 +00:00
Andrew M. Kuchling a883701dff Provide encoding as keyword argument; soften warning paragraph about encodings 2006-05-02 11:30:03 +00:00
Fred Drake 017e68c413 SF #1479988: add methods to allow access to weakrefs for the
weakref.WeakKeyDictionary and weakref.WeakValueDictionary
2006-05-02 06:53:59 +00:00
Neal Norwitz c4edb0ec81 SF #1479181: split open() and file() from being aliases for each other. 2006-05-02 04:43:14 +00:00
Andrew M. Kuchling 4bbf66e852 Markup fixes 2006-05-01 17:06:54 +00:00
Andrew M. Kuchling 6849488914 Add item 2006-05-01 16:32:49 +00:00
Andrew M. Kuchling edbe657174 Markup fixes; add some XXX comments noting problems 2006-05-01 16:30:25 +00:00
Fred Drake d22c6dbdfa add dependency 2006-05-01 16:28:54 +00:00
Martin v. Löwis 5f4307491e Add msilib documentation. 2006-05-01 16:12:44 +00:00
Gerhard Häring 82560ebb8d Further integration of the documentation for the sqlite3 module. There's still
quite some content to move over from the pysqlite manual, but it's a start now.
2006-05-01 15:14:48 +00:00
Andrew M. Kuchling e3c958c33b Some ElementTree fixes: import from xml, not xmlcore; fix case of module name; mention list() instead of getchildren() 2006-05-01 12:45:02 +00:00
Fred Drake 6550f03216 - minor clarification in section title
- markup adjustments
(there is clearly much to be done in this section)
2006-05-01 06:25:58 +00:00
Andrew M. Kuchling 09612281ef Add item 2006-04-30 21:19:49 +00:00
Andrew M. Kuchling 4b5caae8b9 Add urllib2 HOWTO from Michael Foord 2006-04-30 21:19:31 +00:00
Georg Brandl 3c1983face Patch #1479438: add \keyword markup for "with". 2006-04-30 19:34:19 +00:00
Georg Brandl 3583cff5a9 Patch #1472854: make the rlcompleter.Completer class usable on non-
UNIX platforms.
2006-04-30 18:14:54 +00:00
Georg Brandl fa42bd7af4 Patch #1470846: fix urllib2 ProxyBasicAuthHandler. 2006-04-30 07:06:11 +00:00
George Yoshida 5085fe2bcc Use \versionchanged instead of \versionadded for new parameter support. 2006-04-30 03:49:56 +00:00
Andrew M. Kuchling c9236111ed Add two items 2006-04-30 01:07:09 +00:00
Gerhard Häring eb2e1926ac This is the start of documentation for the sqlite3 module. Please feel free to
find a better place for the link to it than alongside bsddb & friends.
2006-04-29 23:12:41 +00:00
Andrew M. Kuchling aa013da0b3 Add item 2006-04-29 12:10:43 +00:00
Andrew M. Kuchling 18db487692 Make case of 'ZIP' consistent 2006-04-29 12:10:28 +00:00
Andrew M. Kuchling b37bcb59bc Add item 2006-04-29 11:53:15 +00:00
George Yoshida f674939a2b grammar fix 2006-04-29 02:43:30 +00:00
George Yoshida d77167286f correct a dead link 2006-04-28 16:40:14 +00:00
Georg Brandl 677800723a Bug #1475009: clarify ntpath.join behavior with absolute components 2006-04-28 16:36:55 +00:00
George Yoshida 9dea97a224 fix markup glitch 2006-04-28 16:09:45 +00:00
George Yoshida 8bf939864b markup fix 2006-04-27 13:41:07 +00:00
Andrew M. Kuchling efd3a09fad Mention the xmlrpclib.Error base class, which is used in one of the examples 2006-04-27 12:42:54 +00:00
Andrew M. Kuchling 356f938f94 [Bug #1477140] Import Error base class 2006-04-27 12:38:35 +00:00
Andrew M. Kuchling 7acb7b40ba [Bug #1477102] Add necessary import to example
This may be a useful style question for the docs -- should examples show
the necessary imports, or should it be assumed that the reader will
figure it out?  In the What's New, I'm not consistent but usually opt
for omitting the imports.
2006-04-27 12:34:39 +00:00
Andrew M. Kuchling 99714cf9d0 Bump document version 2006-04-27 12:23:07 +00:00
Andrew M. Kuchling 1e649be16e Now that 2.5a2 is out, revert to the current date 2006-04-27 12:22:37 +00:00
Anthony Baxter c7d00327ab 2.5a2 2006-04-27 02:11:24 +00:00
Fred Drake 4b8ec63114 add missing word 2006-04-27 00:20:14 +00:00
Fred Drake dbb8c4123f - update version numbers in file names again, until we have a better way
- elaborate instructions for Cygwin support (closes SF #839709)
2006-04-27 00:02:24 +00:00
Fred Drake 0999433f40 one more place to use the current Python version 2006-04-26 23:40:32 +00:00
Andrew M. Kuchling 98189244a2 Add labels to all sections 2006-04-26 12:23:39 +00:00
Andrew M. Kuchling 7e5abb9d1f [Bug #1475080] Fix example 2006-04-26 12:21:06 +00:00
Nick Coghlan 790c3c1377 Fix an error in the last contextlib.closing example 2006-04-26 11:50:04 +00:00
Fred Drake a5f1fd09eb minor adjustment suggested by Peter Gephardt 2006-04-26 05:19:39 +00:00
Fred Drake 2afbf96f53 markup fixes, cleanup 2006-04-26 05:15:41 +00:00
George Yoshida 3bbbc49060 minor tweak 2006-04-25 14:09:58 +00:00
Andrew M. Kuchling d798a181ab Rework context terminology 2006-04-25 12:47:25 +00:00
Andrew M. Kuchling b33842ac51 Add two items; easy_install is now off the table, though pkgutil still is 2006-04-25 12:31:38 +00:00
Thomas Wouters 34a70c6011 Fix markup glitch in unittest docs. Will backport. 2006-04-25 12:28:56 +00:00
Nick Coghlan e708cf5d0f Fix latex typo 2006-04-25 11:05:56 +00:00
Nick Coghlan a7e820a408 Move the PEP 343 documentation and implementation closer to the
terminology in the alpha 1 documentation.

 - "context manager" reverts to its alpha 1 definition
 - the term "context specifier" goes away entirely
 - contextlib.GeneratorContextManager is renamed GeneratorContext

There are still a number of changes relative to alpha 1:

  - the expression in the with statement is explicitly called the
    "context expression" in the language reference
  - the terms 'with statement context', 'context object' or 'with
    statement context' are used in several places instead of a bare
    'context'. The aim of this is to avoid ambiguity in relation to the
    runtime context set up when the block is executed, and the context
    objects that already exist in various application domains (such as
    decimal.Context)
  - contextlib.contextmanager is renamed to contextfactory
    This best reflects the nature of the function resulting from the
    use of that decorator
  - decimal.ContextManager is renamed to WithStatementContext
    Simple dropping the 'Manager' part wasn't possible due to the
    fact that decimal.Context already exists and means something
    different. WithStatementContext is ugly but workable.

A technically unrelated change snuck into this commit:
contextlib.closing now avoids the overhead of creating a
generator, since it's trivial to implement that particular
context manager directly.
2006-04-25 10:56:51 +00:00
Neal Norwitz 327ea38cc4 Revert previous change, SKIP had a versionadded elsewhere 2006-04-25 05:49:42 +00:00
Neal Norwitz 85c767ac87 versionadded for SKIP 2006-04-25 05:04:35 +00:00
Tim Peters 711bf30b89 Patch #1475231: add a new SKIP doctest option, thanks to
Edward Loper.
2006-04-25 03:31:36 +00:00
Andrew M. Kuchling 0a7ed8c2d3 Edits, using the new term
'context specifier' in a few places
2006-04-24 14:30:47 +00:00
Nick Coghlan 877cf234c9 Change PEP 343 related documentation to use the term context specifier instead of context object 2006-04-24 04:17:02 +00:00
Tim Peters 8dc73d2dc6 Bug #1337990: clarified that `doctest` does not support examples
requiring both expected output and an exception.

I'll backport to 2.4 next.
2006-04-24 02:03:16 +00:00
Andrew M. Kuchling d4c2177b78 Add two items 2006-04-23 21:51:10 +00:00
Andrew M. Kuchling edb575e758 Edits to the PEP 343 section 2006-04-23 21:01:04 +00:00
Skip Montanaro 9ab2f453ac it's always helpful if the example works... 2006-04-23 19:30:50 +00:00
Skip Montanaro 56a3706fcd minor tweak 2006-04-23 19:26:33 +00:00
Skip Montanaro 47767c3b17 first cut at trace module doc 2006-04-23 19:14:27 +00:00
Nick Coghlan 09b1bc39e7 Take 2 on mentioning the with statement, this time without inadvertently killing the Unicode examples 2006-04-23 16:35:19 +00:00
Nick Coghlan e0ea50bc3b Add a (very) brief mention of the with statement to the end of chapter 8 2006-04-23 16:05:04 +00:00
Nick Coghlan fee3dfc061 Update with statement documentation to use same terminology as 2.5a1 implementation 2006-04-23 15:39:16 +00:00
Nick Coghlan 5ef9d9fdb9 Update contextlib documentation to use the same terminology as the module implementation 2006-04-23 15:14:37 +00:00
Nick Coghlan 84faa85775 Add a Context Types section to parallel the Iterator Types section (uses the same terminology as the 2.5a1 implementation) 2006-04-23 15:13:32 +00:00
George Yoshida a1d3b1011e wrap SyntaxError with \exception{} 2006-04-23 09:27:10 +00:00
Greg Ward ab05edc0d1 Update optparse to Optik 1.5.1. 2006-04-23 03:47:58 +00:00
George Yoshida 51a23fe266 - add versionadded tag
- make arbitrary arguments come last
2006-04-22 15:27:14 +00:00
George Yoshida 3c134a2046 Typo fixes 2006-04-22 15:10:49 +00:00
Neal Norwitz 8694a6db0e Add libctypes as a dep 2006-04-22 06:07:46 +00:00
Andrew M. Kuchling 1da4a94719 Add Gregory K. Johnson's revised version of mailbox.py (funded by
the 2005 Summer of Code).

The revision adds a number of new mailbox classes that support adding
and removing messages; these classes also support mailbox locking and
default to using email.Message instead of rfc822.Message.

The old mailbox classes are largely left alone for backward compatibility.
The exception is the Maildir class, which was present in the old module
and now inherits from the new classes.  The Maildir class's interface
is pretty simple, though, so I think it'll be compatible with existing
code.

(The change to the NEWS file also adds a missing word to a different
news item, which unfortunately required rewrapping the line.)
2006-04-22 02:32:43 +00:00
Andrew M. Kuchling 3ccdb6ab36 Typo fixes 2006-04-22 01:51:41 +00:00
Phillip J. Eby a93ee47422 Guido wrote contextlib, not me, but thanks anyway. ;) 2006-04-21 21:53:37 +00:00
Thomas Heller 9f7e58afa7 Documentation for ctypes.
I think that 'generic operating system services' is the best category.
Note that the Doc/lib/libctypes.latex file is generated from reST sources.
You are welcome to make typo fixes, and I'll try to keep the reST sources
in sync, but markup changes would be lost - they should be fixed in the tool
that creates the latex file.
The conversion script is external/ctypes/docs/manual/mkpydoc.py.
2006-04-21 18:29:17 +00:00
George Yoshida cd84b92f08 Correct the grammar 2006-04-21 16:34:17 +00:00
George Yoshida 0d840285c7 Fix a markup.
This generated a ugly code, "P&gt;".
2006-04-21 16:21:12 +00:00