Commit Graph

7354 Commits

Author SHA1 Message Date
Benjamin Peterson cdbe29902e fix grammar 2015-04-19 23:14:37 -04:00
Berker Peksag 37de910b52 Mark TarInfo.frombuf() and TarInfo.fromtarfile() as classmethods. 2015-04-19 04:37:35 +03:00
Berker Peksag e4dde50c78 Issue #15566: Document encoding and errors parameters of TarInfo.frombuf().
Patch by Andy Holst.
2015-04-19 04:32:23 +03:00
Vinay Sajip 2d965c2555 Issue #23536: Clarified scope of fileConfig()'s API. 2015-04-18 13:14:10 +01:00
Gregory P. Smith 23a6a0daa1 remove trailing space :) 2015-04-14 10:04:30 -07:00
Gregory P. Smith f2a448a66b issue22046: mention that zipfile can raise NotImplementedError on unsupported
compression algorithms.
2015-04-14 10:02:20 -07:00
Berker Peksag 4882cacab6 Issue #23943: Fix typos. Patch by Piotr Kasprzyk. 2015-04-14 09:30:01 +03:00
Zachary Ware ae9f0fede3 Issue #23730: Document the return value of ZipFile.extract
Patch by Stéphane Wirtel.
2015-04-13 16:40:49 -05:00
Antoine Pitrou 97aa953550 Fix duplicate doc entry for SSLContext.get_ca_certs()
(closes #18147)
2015-04-13 21:06:15 +02:00
Berker Peksag 9575e1891f Issue #12955: Change the urlopen() examples to use context managers where appropriate.
Patch by Martin Panter.
2015-04-12 13:52:49 +03:00
Antoine Pitrou 8ad751e024 Close #23904: fix pathlib documentation misleadingly mentioning that bytes objects are accepted in the PurePath constructor 2015-04-12 00:08:02 +02:00
Benjamin Peterson 1c69c3e3d8 use imperative 2015-04-11 07:42:42 -04:00
Berker Peksag eb7a97c48e Issue #23025: Add a mention of os.urandom to RAND_bytes and RAND_pseudo_bytes docs.
Patch by Alex Gaynor.
2015-04-10 16:19:13 +03:00
Tim Golden fe5ac52c2b Fix typo in telnet docs (reported by Keith Briggs) 2015-04-08 16:52:27 +01:00
Benjamin Peterson 6f362fa6c8 actually ssl3 is just completely broken 2015-04-08 11:11:00 -04:00
Berker Peksag 7ecfc82edb Issue #23400: Raise same exception on both Python 2 and 3 if sem_open is not available.
Patch by Davin Potts.
2015-04-08 17:56:30 +03:00
Tim Golden 42c235e833 Added missing right bracket (reported by Daryl Klakouski) 2015-04-06 11:04:49 +01:00
Victor Stinner 72dcb0a765 Issue #23219: Update asyncio.wait_for() documentation
the wait is cancelled, the future *fut* is now also cancelled.
2015-04-03 17:08:19 +02:00
Benjamin Peterson 8218bd4caf document what exactly str.splitlines() splits on (closes #12855)
Patch by Martin Panter.
2015-03-31 21:20:36 -04:00
Raymond Hettinger c43a666ba2 Issue #23729: Improve docs for ElementTree namespace parsing 2015-03-30 20:29:28 -07:00
Ezio Melotti 2e3998fae0 #11468: improve unittest basic example. Initial patch by Florian Preinstorfer. 2015-03-24 12:42:41 +02:00
Raymond Hettinger f6e31b79a8 Issue 23729: Document ElementTree namespace handling and fix an omission in the XPATH predicate table. 2015-03-22 15:29:09 -07:00
R David Murray beed8402ca #23539: Set Content-Length to 0 for PUT, POST, and PATCH if body is None.
Some http servers will reject PUT, POST, and PATCH requests if they
do not have a Content-Length header.

Patch by James Rutherford, with additional cleaning up of the
'request' documentation by me.
2015-03-22 15:18:23 -04:00
Benjamin Peterson 218144a94d clarify behavior of shutil.move when destination exists (closes #22933)
Patch by Mike Short.
2015-03-22 10:11:54 -04:00
R David Murray 63998a3520 #11726: Make linecache docs reflect that all files are treated the same.
Being able to read non-python text files is not a purpose of linecache, but it
does work and people use it.  This changeset adjusts the language to make it
clear that Python files are not treated uniquely, but does not go so far as to
say reading non-python files is explicitly supported.
2015-03-20 11:31:38 -04:00
Victor Stinner 376658fa13 Issue #11726: Fix linecache example in the doc
Use a Python source file (linecache.__file__) instead of /etc/passwd.

Modify also linecache docstrings to clarify the linecache is written to cache
Python source files, not any text files.
2015-03-18 14:16:50 +01:00
Victor Stinner 93f0665fb6 Issue #11726: clarify linecache doc: linecache is written to cache Python
source files, even if "it works" with other text files encoded to UTF-8.
2015-03-18 14:14:42 +01:00
Benjamin Peterson 59c4eb71f2 versionchanged for rc4 removal (closes #23679) 2015-03-16 12:43:38 -05:00
Eli Bendersky 39430daa3b Issue #23549: Clarify confusion in heapq doc - accessing the mininmal element
The current documentation only mentions heap[0] as the smallest element in the
beginning, and not in any of the methods' docs. There's no method to access the
minimal element without popping it, and the documentation of nsmallest is
confusing because it may suggest that min() is the way to go for n==1.
2015-03-14 20:14:23 -07:00
Serhiy Storchaka b19542d062 Fix minor docs markup errors. 2015-03-14 21:32:57 +02:00
Benjamin Peterson 0d70ab6b8c __getslice__ certainly won't appear in the output 2015-03-13 16:21:23 -05:00
Benjamin Peterson f0f14f72bb use the meth role for ZipFile.open 2015-03-12 22:41:06 -05:00
Berker Peksag ce77ee9183 Issue #22154: Add an example to show context management protocol support of ZipFile.open().
Patch by Mike Short.
2015-03-13 02:29:54 +02:00
Serhiy Storchaka a60c2fe480 Issue #23641: Cleaned out legacy dunder names from tests and docs.
Fixed 2 to 3 porting bug in pynche.ColorDB.
2015-03-12 21:56:08 +02:00
Victor Stinner 84c717dd9e asyncio doc: changes on the Queue API missed Python 3.4.3 release 2015-03-10 16:27:54 +01:00
Berker Peksag 77a6b20a35 Issue #23432: Remove duplicate content from SystemExit docs.
Also, document SystemExit.code attribute explicitly.
2015-03-10 14:47:15 +02:00
Victor Stinner 47c41b4e4d Issue #23605: os.walk() doc now mentions shutil.rmtree() in the last example 2015-03-10 13:31:47 +01:00
Ned Deily 8be2142377 Issue #23617: Correct plurals typo noted by Kentrell Johnson. 2015-03-09 01:55:02 -07:00
Benjamin Peterson c8358273ae indicate correct version (closes #23608) 2015-03-08 09:42:25 -04:00
Benjamin Peterson 8c69ecf95d replace Amazon links in the documentation (closes #23579)
Patch by Sayan Chowdhury.
2015-03-07 09:34:16 -05:00
Benjamin Peterson 990fcaac3c expose X509_V_FLAG_TRUSTED_FIRST 2015-03-04 22:49:41 -05:00
Benjamin Peterson bdf525b77c wrap everything at 80 chars 2015-03-02 09:31:40 -05:00
Benjamin Peterson 29fec92875 link to the correct dis method or function (closes #23561) 2015-03-02 09:27:43 -05:00
Berker Peksag ab4040e3c6 Issue #20521: Change ``TOS`` to TOS in dis documentation.
TOS is an abbreviation of top-of-stack.

Patch by Sven Berkvens-Matthijsse.
2015-03-02 06:33:30 +02:00
Zachary Ware 0b49637890 Fix copy/paste error in bytes.isupper() doc.
Reported by Jon Colburn on docs@.
2015-02-27 01:40:22 -06:00
Victor Stinner 7b2c3c6840 asyncio doc: lock classes are not thread safe 2015-02-26 10:39:16 +01:00
Victor Stinner 83704963c0 asyncio: add a note about (non) thread safety in each class 2015-02-25 14:24:15 +01:00
Victor Stinner 532c69a428 asyncio doc: begin with warnings on asyncio traps 2015-02-25 14:23:51 +01:00
Victor Stinner 615a58eaab asyncio doc: move queues to a new page 2015-02-25 13:55:43 +01:00
Georg Brandl 7e91af3a91 Remove unsupported (in latex) character from the source. 2015-02-25 13:05:53 +01:00
Victor Stinner b8064a8a16 asyncio doc: close explicitly event loops 2015-02-23 11:41:56 +01:00
Ned Deily 75790938a4 Issue #23499: Fix grammar error noticed by SilentGhost 2015-02-22 16:14:32 -08:00
Serhiy Storchaka a3369a524c Issues #814253, #9179: Warnings now are raised when group references and
conditional group references are used in lookbehind assertions in regular
expressions.
2015-02-21 12:08:52 +02:00
Berker Peksag babc688180 Issue #23439: Add missing entries to http.client.__all__.
Also, document the LineTooLong exception since it can be raised by
the members of public API (e.g. http.client.HTTPResponse).

Patch by Martin Panter.
2015-02-20 09:39:38 +02:00
Zachary Ware 56dee1e463 Fix typo pointed out on docs@ by Yaniv Sayeh 2015-02-19 22:30:15 -06:00
Benjamin Peterson 70e2847347 document the requestline and close_connection attributes, use real booleans, and add tests (closes #23410)
Patch by Martin Panter.
2015-02-17 21:11:10 -05:00
Victor Stinner f91d845797 asyncio, Tulip issue 220: Update doc of asyncio.Queue, add join and task_done
methods
2015-02-17 23:09:52 +01:00
Berker Peksag 4d6c6063bf Fix typo in os.supports_effective_ids documentation. 2015-02-16 03:36:10 +02:00
Berker Peksag 50ef8a8e67 Issue #13637: Remove outdated versionchanged directives.
Patch by Martin Panter.
2015-02-15 00:05:42 +02:00
Victor Stinner bdd574d09a asyncio doc: annotate coroutine on coroutine functions and methods 2015-02-12 22:49:18 +01:00
Ned Deily 50afcc09ac Fix missing :ref: for idle in doc build. 2015-02-06 15:42:06 +11:00
Victor Stinner 6a1b004b83 asyncio doc: explain how to display ResourceWarning in the debug mode section 2015-02-04 16:14:33 +01:00
Victor Stinner 17d87f8ae4 asyncio, Tulip issue 221: Fix doc of QueueEmpty and QueueFull 2015-02-03 15:09:24 +01:00
Serhiy Storchaka c057c3859c Issue #23099: Closing io.BytesIO with exported buffer is rejected now to
prevent corrupting exported buffer.
2015-02-03 02:00:18 +02:00
R David Murray 756f0b1982 Fix asyncio doc typo. 2015-01-29 19:53:33 -05:00
Victor Stinner 188f2c0b75 asyncio doc: document the new ResourceWarning warnings 2015-01-30 01:35:14 +01:00
Victor Stinner 1077dee457 asyncio doc: add a section about task cancellation 2015-01-30 00:55:58 +01:00
Victor Stinner 7a55b88d9c Issue #21962, asyncio doc: Suggest the usage of wait_for() to replace
the lack of timeout parameter for locks and queues.
2015-01-30 00:37:04 +01:00
Victor Stinner 54a231d539 asyncio doc: document Protocol state machine 2015-01-29 13:33:15 +01:00
Serhiy Storchaka b76bcc4ffc Issue #14099: Backout changeset e5bb3044402b (except adapted tests). 2015-01-26 13:45:39 +02:00
Serhiy Storchaka 2bef58577f Issue #18518: timeit now rejects statements which can't be compiled outside
a function or a loop (e.g. "return" or "break").
2015-01-26 12:09:17 +02:00
R David Murray 1923b627b5 #23215: reflow paragraph. 2015-01-25 15:46:22 -05:00
R David Murray f1f9675b8a #23251: Note that time.sleep affects the calling thread only.
This change parallels the language used in the unix man page.
2015-01-25 15:45:14 -05:00
Vinay Sajip ff37cfe9cc Issue #23305: clarified RotatingFileHandler documentation. 2015-01-23 21:19:04 +00:00
Berker Peksag 5a494f6ad8 Issue #22317: Document the action parameter in ArgumentParser.add_subparsers() docs.
Patch by Mike Short.
2015-01-20 06:45:53 +02:00
Serhiy Storchaka d3faf43f9b Issue #23181: More "codepoint" -> "code point". 2015-01-18 11:28:37 +02:00
Ned Deily ccb416fee2 Issue #23180: Rename IDLE "Windows" menu item to "Window".
Patch by Al Sweigart.
2015-01-17 21:06:27 -08:00
Ethan Furman 8a12329281 Issue22997: minor doc update; thanks to Simoen Visser 2015-01-14 22:31:50 -08:00
Benjamin Peterson 82f34ada45 fix instances of consecutive articles (closes #23221)
Patch by Karan Goel.
2015-01-13 09:17:24 -05:00
Antoine Pitrou 73dd030c8b Issue #22952: improve multiprocessing doc introduction and defer notes until appropriate.
Patch by Davin Potts.
2015-01-11 15:05:29 +01:00
Mark Dickinson dfe0b2326b Issue #21902: Replace incorrect 'hyperbolic arc sine' (etc.) with 'inverse hyperbolic sine' (etc.). Remove meaningless reference to radians. 2015-01-11 13:08:05 +00:00
Victor Stinner 7eb10311be asyncio: SelectSelector is limited to 512 sockets on Windows 2015-01-09 15:59:44 +01:00
Victor Stinner a092a615f5 asyncio doc: fix section of event loop examples 2015-01-09 15:58:41 +01:00
Victor Stinner 399c59d7bd asyncio doc: list limitations to run subprocesses from different threads 2015-01-09 01:32:02 +01:00
Berker Peksag 283f1aa881 Issue #20487: Clarify meaning of "side effect" in the magic mock documentation.
Patch by A.M. Kuchling.
2015-01-07 21:15:02 +02:00
Nick Coghlan b9fdb7a452 Issue 19548: update codecs module documentation
- clarified the distinction between text encodings and other codecs
- clarified relationship with builtin open and the io module
- consolidated documentation of error handlers into one section
- clarified type constraints of some behaviours
- added tests for some of the new statements in the docs
2015-01-07 00:22:00 +10:00
Zachary Ware 5819cfa5aa Cosmetic fixes to the 'Develop with asyncio' page 2015-01-06 00:40:43 -06:00
Benjamin Peterson b461000a3f the current marshal version is 4 (closes #23167)
Patch by Dmitry Kazakov.
2015-01-04 16:29:48 -06:00
Benjamin Peterson bab69bf655 update docs for #23111 2014-12-30 15:17:03 -06:00
Benjamin Peterson 5feeebaa84 use a proper m-dash 2014-12-28 22:14:15 -06:00
Berker Peksag a1a1409e42 Issue #23125: Update nose project page link.
Reported by Damien Marié.
2014-12-28 18:48:33 +02:00
R David Murray 8c4e112afc #23040: Clarify treatment of encoding and errors when component is bytes.
Patch by Wojtek Ruszczewski.
2014-12-24 21:23:18 -05:00
Victor Stinner 4f9b773a64 asyncio doc: Fix doc of get and put methods of Queue 2014-12-22 22:07:06 +01:00
Barry Warsaw 904c481099 Fix typo. 2014-12-19 11:20:00 -05:00
Raymond Hettinger 558dcf38e6 Issue #23049: Pure python equivalent shouldn't imply more exactitude than is really there. 2014-12-16 18:16:57 -08:00
Victor Stinner 4d5115c7b5 asyncio doc: call_soon() does not call immediatly the callback. Patch written
by Martin Panter.
2014-12-15 17:50:55 +01:00
Raymond Hettinger d2a296a73a Issue 23005: Fix typos 2014-12-11 23:56:32 -08:00
Serhiy Storchaka b252b5ab0c Issue #22823: Fixed an output of sets in examples. 2014-12-11 10:30:21 +02:00
Terry Jan Reedy e40031d1db whitespace 2014-12-10 18:49:58 -05:00
Terry Jan Reedy 06c6218d00 Issue #23006 whitespace 2014-12-10 18:48:23 -05:00
Terry Jan Reedy b67f6e27e1 Issue #23006: Improve the documentation and indexing of dict.__missing__.
Add an entry in the language datamodel special methods section.
Revise and index its discussion in the stdtypes mapping/dict section.
2014-12-10 18:38:19 -05:00
Berker Peksag 8b1cbd2b7c Issue #12602: Add missing cross-references to runpy and using/cmdline docs.
Patch by Éric Araujo.
2014-12-10 01:47:02 +02:00
Benjamin Peterson e3b743cd3e fix reference by adding module name 2014-12-07 17:26:38 -05:00
Benjamin Peterson a090f01bb6 HTTPSConnection: prefer the context's check_hostname attribute over the constructor parameter (#22959) 2014-12-07 13:18:25 -05:00
Benjamin Peterson b92fd01189 note that sslv3 may not be available 2014-12-06 11:36:32 -05:00
Serhiy Storchaka b757c83ec6 Issue #22581: Use more "bytes-like object" throughout the docs and comments. 2014-12-05 22:25:22 +02:00
Terry Jan Reedy 3ab745e386 Edit Menus section of Idle doc. Make menu entries match current Idle in order
and case.  Edit some of the explanatory sentences and end all with a period.
2014-12-05 02:43:07 -05:00
Yury Selivanov a5ef83244b docs.inspect: Fix BoundArguments example. Issue #22998. 2014-12-04 22:47:44 -05:00
Terry Jan Reedy bb37b4ca73 Issue #3068: Document the new Configure Extensions dialog and menu entry. 2014-12-04 01:26:04 -05:00
Terry Jan Reedy f56849486b Issue #16893: For Idle doc, move index entries, copy no-subprocess section
from idlelib/help.txt, add 'C' comment, and remove obsolete ^Z comment
Original patch by Zach Ware.
2014-12-04 00:54:59 -05:00
Antoine Pitrou 2b207badd6 Fix #22987: update the compatibility matrix for a SSLv23 client. 2014-12-03 20:00:56 +01:00
Serhiy Storchaka 1ad088f3ea Issue #14099: ZipFile.open() no longer reopen the underlying file. Objects
returned by ZipFile.open() can now operate independently of the ZipFile even
if the ZipFile was created by passing in a file-like object as the first
argument to the constructor.
2014-12-03 09:11:57 +02:00
Victor Stinner d87de83582 Closes #22475: asyncio doc, fix Task.get_stack() doc 2014-12-02 17:57:04 +01:00
Victor Stinner 039f703b7b Close #22473: asyncio doc: rephrase Future with run_forever() example 2014-12-02 17:52:45 +01:00
Serhiy Storchaka 56a6d855e2 Removed duplicated words in in comments and docs. 2014-12-01 18:28:43 +02:00
Benjamin Peterson b7138e24e3 context is keyword-only 2014-11-29 23:38:17 -05:00
Benjamin Peterson c1da3d1ed8 add context parameter to xmlrpclib.ServerProxy (#22960)
Patch by Alex Gaynor.
2014-11-29 23:32:57 -05:00
Victor Stinner e7182979d6 Closes #22348: Rephrase asyncio.StreamWriter.drain() documentation
Patch written by Martin Richard.
2014-11-28 17:45:41 +01:00
Victor Stinner 1deee54e0c asyncio doc: reformat event loop policy doc 2014-11-28 13:58:28 +01:00
Victor Stinner 8464c24c82 asyncio doc: explain how to pass keywords to callbacks (functools.partial) 2014-11-28 13:15:41 +01:00
Serhiy Storchaka 7a6915e17d Issue #21514: The documentation of the json module now refers to new JSON RFC
7159 instead of obsoleted RFC 4627.
2014-11-27 19:41:47 +02:00
Zachary Ware 4847035458 pydoc: Add a note about setting PAGER to affect console output pagination.
Suggested by James Lowden on docs@.
2014-11-26 23:44:25 -06:00
Ethan Furman b004943e9b (3.4) Issue22780: reword NotImplemented docs to emphasise should 2014-11-26 21:15:35 -08:00
Zachary Ware 61aebca09d pydoc: Remove mention of '-g' command line option, document its removal. 2014-11-26 22:57:35 -06:00
Berker Peksag c8c64e30e8 Issue #20351: Add examples for csv.DictReader and csv.DictWriter.
Patch by Charles-Axel Dein.
2014-11-24 23:46:30 +02:00
Benjamin Peterson 43052a14c1 add context parameter to HTTPHandler (closes #22788) 2014-11-23 20:36:44 -06:00
Benjamin Peterson dbd4bcfcca correct versionchanged version 2014-11-23 20:09:31 -06:00
Benjamin Peterson 7243b574e5 don't require OpenSSL SNI to pass hostname to ssl functions (#22921)
Patch by Donald Stufft.
2014-11-23 17:04:34 -06:00
Benjamin Peterson 378e15d7ab document that cadefault does nothing now 2014-11-23 11:43:33 -06:00
Serhiy Storchaka f751a9e6a2 Issue #22845: Improved formatting of dis documentation. 2014-11-11 10:02:11 +02:00
Berker Peksag 4900877bca Issue #22839: Fix Snapshot.statistics() link. 2014-11-10 23:15:32 +02:00
Raymond Hettinger 86e9b6b164 Issue 22830: Clarify docs for functools.cmp_to_key(). 2014-11-09 17:20:56 -08:00
Berker Peksag b556399fb5 Issue #22808: Link to the correct time method in BaseEventLoop.call_at().
Patch by Mark Grandi.
2014-11-07 19:51:07 +02:00
Raymond Hettinger dc69e03ef3 Issue 22803: Add missing versionadded directive. 2014-11-05 21:27:56 -08:00
Georg Brandl b9b389efed Closes #22525: clarify documentation for ast.literal_eval(). 2014-11-05 20:20:28 +01:00
Benjamin Peterson 4ffb075271 PEP 476: enable HTTPS certificate verification by default (#22417)
Patch by Alex Gaynor with some modifications by me.
2014-11-03 14:29:33 -05:00
Benjamin Peterson a5c9c37dd5 wrap 2014-11-02 13:17:56 -05:00
Senthil Kumaran 8b7e161ac3 backport context argument of urlopen (#22366) for pep 476 2014-09-19 15:23:30 +08:00
R David Murray 64f10d4f5e Reflow paragraph. 2014-11-02 12:32:26 -05:00
R David Murray 3ca68e77b8 Fix English phrasing. 2014-11-02 12:31:47 -05:00
Georg Brandl 36ac510956 Closes #22771: "verbose" is unused; deprecate it. 2014-10-31 10:54:06 +01:00
Georg Brandl 8ed75cd8e9 #22613: minor other fixes in library docs (thanks Jacques Ducasse) 2014-10-31 10:25:48 +01:00
Georg Brandl 2677faecf5 #22613: document Cmd.cmdqueue (thanks Jacques Ducasse) 2014-10-31 10:25:38 +01:00
Georg Brandl 717e02896f #22613: fix heading levels in tracemalloc docs (thanks Jacques Ducasse) 2014-10-31 10:21:07 +01:00
Georg Brandl 9b1b0e54e7 #22613: elaborate on arguments of shutil archival functions (thanks Jacques Ducasse) 2014-10-31 10:02:40 +01:00
Georg Brandl f30132fdc9 #22613: explain what "buffer" is in the struct documentation (thanks Jacques Ducasse) 2014-10-31 09:46:41 +01:00
Georg Brandl e4196d3f2e #22613: fix several factual errors in builtin docs (thanks Jacques Ducasse) 2014-10-31 09:41:46 +01:00
Georg Brandl 4433ff958b unittest.mock docs: fix use of default role 2014-10-31 07:59:37 +01:00
Georg Brandl ef08bde8b8 minor markup fix: no inline markup is allowed in a module synopsis 2014-10-30 22:45:27 +01:00
Georg Brandl 6b4c847c4f Doc: fix default role usage (except in unittest mock docs) 2014-10-30 22:26:26 +01:00
Georg Brandl b7354a65ce Fixing broken links in doc, part 4: some more breaks and redirects 2014-10-29 10:57:37 +01:00
Georg Brandl 525d355984 Fixing broken links in doc, part 3: the rest 2014-10-29 10:26:56 +01:00
Georg Brandl 728e4debd8 Fix external links to docs.python.org to use internal links instead. 2014-10-29 09:00:30 +01:00
Georg Brandl e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Georg Brandl ce64cedff4 Fix module name. 2014-10-28 22:58:24 +01:00
Georg Brandl 946faa39e3 Using "-m module" is easier to read and understand than "-mmodule". 2014-10-28 22:54:24 +01:00
Georg Brandl 2b07b0e868 Closes #22249: use IPPROTO_TCP constant instead of SOL_TCP constant for getaddrinfo() proto param 2014-10-28 22:45:27 +01:00
Georg Brandl c943e79384 Remove duplicate bullet point. 2014-10-28 22:40:48 +01:00
Georg Brandl bb2d669292 Closes #22736: move seealso to the bottom of the section about RE syntax. 2014-10-28 21:41:51 +01:00
Georg Brandl 01546a88b8 Closes #22749: remove outdated advice to use clock() for accurate timing. 2014-10-28 21:35:35 +01:00
Ezio Melotti 788f2adeae #22196: link to Enum in the nametuple documentation. Patch by Karmen Dykstra. 2014-10-28 15:07:14 +01:00
Ezio Melotti 9b1e92f5a1 #22237: document that sorted() is guaranteed to be stable. Initial patch by Martin Panter. 2014-10-28 12:57:11 +01:00
Nick Coghlan 3894ae20ea Issue #22711: improve links in new distribution docs
- key term hyperlinks for distutils, setuptools & wheel
- distutils landing page links directly to setuptools docs
- short summary of setuptools benefits provided with link
2014-10-26 00:00:04 +10:00
Victor Stinner 2cef300187 asyncio doc: fix typo in an example 2014-10-23 22:38:46 +02:00
Victor Stinner c803bd84b5 Issue #22695: Fix syntax of open() doc 2014-10-22 09:55:44 +02:00
Antoine Pitrou 4b4ddb2190 Issue #22660: update various mentions in the ssl module documentation. 2014-10-21 00:14:39 +02:00
Jesus Cea 67503c5f1c Docs: 'os.pwrite()' needs bytes, not strings 2014-10-20 16:18:24 +02:00
Benjamin Peterson 0fc08fd2c7 merge 3.3 2014-10-19 10:47:58 -04:00
Benjamin Peterson 9fc59c9fc2 make plural s lowercase 2014-10-19 10:47:49 -04:00
Victor Stinner 7f314ed71b asyncio doc: write simpler examples to introduce asyncio 2014-10-15 18:49:16 +02:00
Ethan Furman 7184bac544 Issue20386: SocketType is again socket.socket; the IntEnum SOCK constants are SocketKind 2014-10-14 18:56:53 -07:00
Victor Stinner 39892055cd asyncio doc: rewrite subprocess doc
* add a new example using transport and protocol
* rewrite the example using streams to make it much simpler (remove error
  handling, use a simpler Python code)
* copy (and adapt) more documentation from the subprocess module:

  - add a note about Process.wait() deadlock
  - add a note about shell injection
  - etc.

* sort Process methods and attributes in the same order than subprocess.Popen
  methods and attributes, so the documentation looks closer
* list differences between Process and subprocess.Popen APIs
2014-10-14 00:52:07 +02:00
Victor Stinner 3c95062f52 asyncio doc: protocol_factory of subprocess_exec() and subprocess_shell() must
instanciate a subclass of SubprocessProtocol
2014-10-14 00:02:10 +02:00
Victor Stinner 4270a24dd9 asyncio doc: document BaseSubprocessTransport.close() method
Modify also the get_pipe_transport() doc to mention explicitly the supported
file descriptors.
2014-10-13 23:56:43 +02:00
Benjamin Peterson 157da6fdd2 merge 3.3 2014-10-13 11:55:02 -04:00
Benjamin Peterson 77a75b3db1 note xmlrpclib doesn't verify certs (yet) 2014-10-13 11:54:50 -04:00
Victor Stinner ed8e3a987e asyncio: add missing @coroutine decorator 2014-10-13 00:55:50 +02:00
Victor Stinner ab1c853079 asyncio doc: update debug traces 2014-10-12 21:37:16 +02:00
Victor Stinner 980dd84f92 asyncio doc: more explicit doc for async()
The function schedules the execution of coroutines, it's not just a wrapper for
something.
2014-10-12 21:36:17 +02:00
Victor Stinner 33f6abe4ae asyncio doc: reformat create_server() doc
Fix also the reate_unix_connection() doc: the method is not support on Windows,
not need to mention that ssl is not support with ProactorEventLoop.
2014-10-12 20:36:04 +02:00
Victor Stinner ed051594d7 asyncio doc: add TCP echo client/server using streams 2014-10-12 20:18:16 +02:00
Georg Brandl 62b08136d7 Closes #22586: clarify meaning of allow_fragments in urlparse. 2014-10-12 16:13:32 +02:00
Victor Stinner 5366434336 asyncio doc: enhance TCP client example 2014-10-12 11:35:09 +02:00
Victor Stinner cfbea3a02e asyncio doc: clarify how servers create protocol instances 2014-10-12 11:30:17 +02:00
Victor Stinner c7edffdddd asyncio doc: add UDP client and server examples 2014-10-12 11:24:26 +02:00
Victor Stinner c2721b41d3 asyncio doc: use server.wait_closed() in TCP echo server example 2014-10-12 11:13:40 +02:00
Berker Peksag edd6ec2dd3 Issue #22613: Fix reprlib.Repr subclass example on Python 3.
Reported by Jacques Ducasse.
2014-10-12 05:11:16 +03:00
Nick Coghlan 36d8ef9cc7 Issue #21061: correctly note redirect_stdout is reentrant 2014-10-12 10:25:00 +10:00
Victor Stinner ccd8e34508 asyncio doc: socket.socketpair() is not available on Windows yet 2014-10-11 16:30:02 +02:00
Victor Stinner 04e6df330d asyncio doc: add examples showing the 3 ways to wait for data from an open
socket
2014-10-11 16:16:27 +02:00
Victor Stinner 6888b96cee asyncio doc: cleanup Hello World examples 2014-10-11 16:15:58 +02:00
Victor Stinner 5121a9ba4a asyncio doc: the "Get HTTP headers" example now supports HTTPS 2014-10-11 15:52:14 +02:00
Georg Brandl dbf8344404 Closes #18959: move optparse and imp to new "superseded modules" chapter 2014-10-11 14:47:11 +02:00
Georg Brandl c5dd095a9b Closes #21675: fix ordering of description in library intro 2014-10-11 14:32:34 +02:00
Zachary Ware a13dab47cb Issue #15414: Clean and correct the os.path.join docs.
In particular, correctly describe the behavior of ntpath.join.

Based on a patch by Dave Sawyer.
2014-10-10 16:03:14 -05:00
Terry Jan Reedy f9bd920cfa Issue 22603: add missing 'self'. Patch by Francisco Fernández Castaño. 2014-10-10 16:00:18 -04:00
Victor Stinner cfb2a0a855 Issue #22564: ssl doc: mention asyncio in the non-blocking section 2014-10-10 12:45:10 +02:00
Victor Stinner d28fe8c8f4 Issue #22564: ssl doc: mention how SSLSocket are usually created 2014-10-10 12:07:19 +02:00
Victor Stinner 3c3d3c73f3 Issue #22564: ssl doc: use "class" marker to document the SSLSocket class 2014-10-10 12:06:51 +02:00
Victor Stinner 41f92c2818 Issue #22564: ssl doc: document read(), write(), pending, server_side and
server_hostname methods and attributes of SSLSocket.
2014-10-10 12:05:56 +02:00
Victor Stinner 851a6cc071 Issue #22564: ssl doc: fix typos 2014-10-10 12:04:15 +02:00
R David Murray 7445a383a6 #18176: updated stdtypes UCD link, added reminder to makeunicodedata.
Patch by Alexander Belopolsky.
2014-10-09 17:30:33 -04:00
Berker Peksag b2fdafe3d2 Issue #22576: Fix signatures of FTP.storbinary() and FTP.storlines() methods.
The correct parameter name is "fp", not "file".
2014-10-08 13:15:04 +03:00
Larry Hastings 2ce95d7b7c Merge from 3.4.2 release head back into 3.4 mainline. 2014-10-08 02:50:50 -07:00
Georg Brandl 7fa4a8f15a Closes #12148: clarify "or's together option flags" in doctest docs. 2014-10-06 16:56:43 +02:00
Georg Brandl eb7e8f607e Document builtin classes as such, not functions. 2014-10-06 13:54:36 +02:00
Terry Jan Reedy c6ad57608b Issue #22546: update doc for mini-language float None presentation type. 2014-10-06 02:04:33 -04:00
Larry Hastings c6256e5f7d Update pydoc topics and fix supsicious markup for 3.4.2 final. 2014-10-05 19:03:48 -07:00
R David Murray 9db487b31f #14201: Update ctypes docs to match behavior changed from 214b28d7a999.
Original patch by Erik Johansson, slightly updated by Meador Inge.
2014-10-04 18:25:07 -04:00
R David Murray bf92bceaaa #14056: Small improvements to the tarfile documentation.
Patch by Éric Araujo with help from Lars Gustäbel.
2014-10-03 20:18:48 -04:00
Zachary Ware 7280561b5b Fix a few typo/grammar issues in the multiprocessing docs.
Reported by Scott Hinton on docs@.
2014-10-03 10:55:12 -05:00
Georg Brandl 3f1ef9efd5 Closes #18729: minor markup improvement. 2014-10-02 12:37:50 +02:00
Georg Brandl c0a8f8ce84 closes #22528: add source links to symtable and compileall 2014-10-02 08:38:39 +02:00
Terry Jan Reedy 6e978d2754 Issue #21971: Index and update turtledemo doc. 2014-10-02 00:16:31 -04:00
Terry Jan Reedy 1895f2b544 Issue 22492: Be explicit that print does not support binary mode files.
Original patch by Georg Brandl.
2014-10-01 15:37:42 -04:00
Benjamin Peterson 45d929dc64 add link to pdb source (closes #22528) 2014-09-30 16:02:06 -04:00
Berker Peksag 9c1dba2758 Revert #22251 2014-09-28 00:00:58 +03:00
Berker Peksag 3749404ba5 Issue #22251: Fix ReST markup to avoid errors building docs. 2014-09-27 23:21:35 +03:00
R David Murray 9cc5fd7b59 #18854: make it explicit that is_multipart does not mean 'multipart/xxx'.
Original patch (and the idea of using _structure) by Abhilash Raj.
2014-09-27 15:37:40 -04:00
R David Murray 1f3a88fe55 #20974: Update version table in email intro.
Note that the email version string in 3.3 and 3.4 is inaccurate, since it
still exists but wasn't updated while the code was.
2014-09-27 14:59:36 -04:00
Berker Peksag 6c1f0ad665 Issue #17462: Add a paragraph about advantages of argparse over optparse.
Patch by Anastasia Filatova.
2014-09-26 15:34:26 +03:00
R David Murray 22dd8334cd Improve English phrasing in asyncio task docs. 2014-09-24 11:09:09 -04:00
Benjamin Peterson eb83ffe1b3 fix error in split() examples (closes #22459)
Patch by Raúl Cumplido.
2014-09-22 22:43:50 -04:00
Jesus Cea ca2e02cfe6 Typo: headeronly -> headersonly 2014-09-22 00:43:39 +02:00
Antoine Pitrou afe8d0646c Issue #21332: Ensure that ``bufsize=1`` in subprocess.Popen() selects line buffering, rather than block buffering. 2014-09-21 21:10:56 +02:00
R David Murray 8a97896a76 #21091: make is_attachment a method.
Since EmailMessage is a provisional API we can fix API bugs in a
maintenance release, but I used a trick suggested by Serhiy to
maintain backward compatibility with 3.4.0/1.
2014-09-20 18:05:28 -04:00
Vinay Sajip 2f1cd8a7fc Issue #22436: Improved documentation for getEffectiveLevel() and getLevelName(). 2014-09-18 18:01:12 +01:00
Berker Peksag 2d510e3bab Issue #14824: Update Repr.repr_TYPE documentation to use correct name mangling implementation.
Patch by Chris Rebert.
2014-09-18 06:05:14 +03:00
Ethan Furman f75805edb8 Issue21738: clarify usage of __new__ in Enum subclasses 2014-09-16 19:13:31 -07:00
Vinay Sajip d1d4fbff63 Issue #22386: fixed regression. 2014-09-11 23:06:09 +01:00
Serhiy Storchaka 148679982f Issue #22369: Change "context manager protocol" to "context management protocol". 2014-09-10 23:43:41 +03:00
Nick Coghlan af117ed3d7 Issue #22346: also include asyncio PEP 411 notice in 3.4 2014-09-06 19:43:06 +10:00
Victor Stinner 41f3c3f226 Closes #22275: asyncio: enhance documentation of OS support 2014-08-31 14:47:37 +02:00
Benjamin Peterson e218bcbf39 getuid() returns real process id not effective (closes #22307) 2014-08-30 21:04:15 -04:00
Victor Stinner d84fd73de2 Issue #22063: Fix asyncio documentation of socket and pipe operations regarding
to non-blocking mode. The non-blocking mode does not matter when using a
ProactorEventLoop, only for SelectorEventLoop.
2014-08-26 01:01:59 +02:00
Victor Stinner 52bb949fd3 asyncio, tulip issue 203: Add _FlowControlMixin.get_write_buffer_limits() method 2014-08-26 00:22:28 +02:00
Victor Stinner d71dcbb043 asyncio: update the doc
* dev: mention that the logging must be configured at DEBUG level
* streams: drain() has no more a strange return value, it's just
  a standard coroutine
2014-08-25 17:04:12 +02:00
Terry Jan Reedy ee55826072 Issue #13540: add missing markup. 2014-08-23 22:21:47 -04:00
Zachary Ware f9dd274692 Issue #22178: Fix the date of the Windows epoch (Jan 1, 1601). 2014-08-11 15:00:48 -05:00
Victor Stinner 337e03ff78 Issue #22112, asyncio doc: replace loop.create_task(coro) with
asyncio.async(coro), mention that asyncio.async() can be used to scheduler a
coroutine, and make it clear that create_task() is only available in Python
3.4.2 and later.
2014-08-11 01:11:13 +02:00
Raymond Hettinger ac191ce1d3 Issue #22174: Clean-up grammar and ambiguities in property() docs. 2014-08-10 10:41:25 -07:00
Raymond Hettinger 31b3683d9b Issue #22180: Remove weak example 2014-08-10 10:33:03 -07:00
Nick Coghlan e4936b830c Issue #21777: separate docs for binary sequence methods 2014-08-09 16:14:04 +10:00
Vinay Sajip 12d9ddf532 Issue #22130: Corrected fileConfig() documentation. 2014-08-05 10:34:16 +01:00
Ezio Melotti 67f6d5f4d0 #21928: clarify functools.wraps docs. 2014-08-05 08:14:28 +03:00
Ezio Melotti 591176e544 #18588: update the timeit examples to be consistent. 2014-08-04 17:01:16 +03:00
Raymond Hettinger c6f22cc0a6 Remove unused leftover stray line 2014-08-04 00:21:11 -07:00
Raymond Hettinger c0de59bfc3 Fix markup. 2014-08-03 23:44:30 -07:00
Raymond Hettinger c566431bf0 Improve regex tokenizer example by using re.finditer().
Also, improve variable names and fix column numbers
in the generated output.
2014-08-03 23:38:54 -07:00
Jason R. Coombs b3d4c212f7 Issue #13540: Merge changes from 3.3 2014-08-03 15:26:58 -04:00
Jason R. Coombs 89e186f24e Issue #13540: Merge changes from 3.2 2014-08-03 15:26:32 -04:00
Jason R. Coombs 79690ac1d0 Issue #13540: Update references to Action class to match syntax used for other classes in this file. 2014-08-03 14:54:11 -04:00
Raymond Hettinger 400daedb13 Fix whitespace in example. 2014-08-02 22:32:10 -07:00
Victor Stinner ec2ce092a2 Issue #22063: Mention in asyncio documentation that socket operations require
the socket to be non-blocking
2014-07-29 23:12:22 +02:00
Andrew Svetlov f200ce6333 Document lock parameter for asyncio.Condition() 2014-07-26 19:50:37 +03:00
Zachary Ware 88a1977a08 Issue #22072: Fix a couple of SSL doc typos. Patch by Alex Gaynor. 2014-07-25 13:30:50 -05:00
Victor Stinner 45cff66cf6 Issue #16133: The asynchat.async_chat.handle_read() method now ignores
BlockingIOError exceptions. Initial patch written by Xavier de Gaye.

Document also in asyncore documentation that recv() may raise BlockingIOError.
2014-07-24 18:49:36 +02:00
Victor Stinner 992019c006 Backport os.rst documentation from Python 3.5. 2014-07-24 12:42:45 +02:00
Victor Stinner 6d4f4feca2 Issue #21813: Enhance documentation of the os.stat_result class. 2014-07-24 12:42:16 +02:00
Andrew Svetlov ca4f34366a Fix incomplete sentence in asyncio docs. 2014-07-24 11:36:33 +03:00
Terry Jan Reedy 9ff41803af Asyncio doc fixes: spelling, grammar, duplication. 2014-07-24 02:59:02 -04:00
Terry Jan Reedy c935a9530c Englich grammar nit. 2014-07-24 02:33:14 -04:00
Terry Jan Reedy 9f5388f24f Fix doc example bug reported on python-list by Akshay Verma. 2014-07-23 20:30:29 -04:00
Zachary Ware f012ba42fe Issue #22002: Make full use of test discovery in test sub-packages.
Adds `load_package_tests` function to test.support, uses it in test_asyncio,
test_email, test_json, test_tools, test_importlib and all test_importlib
sub-packages to implement test discovery.
2014-07-23 12:00:29 -05:00
Andrew Svetlov 588517ca63 Fix grammar 2014-07-23 11:27:17 +03:00
Jason R. Coombs eb0ef415d5 Issue #13540: Removed redundant documentation about Action instance attributes. Updated example and documentation per recommendations by Steven Bethard in msg149524. 2014-07-20 10:52:46 -04:00
Mark Dickinson e004c6cad5 Issue #22006: Remove outdated _thread caveat. Thanks Dan O'Reilly for the report. 2014-07-19 21:45:06 +01:00
Zachary Ware 0069eac0e5 Issue #22004: Correct an argument name. 2014-07-18 09:11:48 -05:00
Victor Stinner d55b54d5c0 asyncio, tulip issue 190: Process.communicate() now ignores
ConnectionResetError too
2014-07-17 13:12:03 +02:00
Victor Stinner cc996b5789 asyncio, tulip issue 190: Process.communicate() must ignore BrokenPipeError
If you want to handle the BrokenPipeError, you can easily reimplement
communicate().

Add also a unit test to ensure that stdin.write() + stdin.drain() raises
BrokenPipeError.
2014-07-17 12:25:27 +02:00
Berker Peksag 38bf87c7f2 Issue #21994: Fix SyntaxError in the SSLContext.check_hostname documentation. 2014-07-17 05:00:36 +03:00
Zachary Ware 8faecbfb42 Fix a minor typo in the turtle docs. Found by Brandon Passmore on docs@. 2014-07-16 14:48:48 -05:00
Raymond Hettinger 8323f68f3e Issue 21977: Minor improvements to the regexes in the tokenizer example. 2014-07-14 01:52:00 -07:00
Victor Stinner 4bfb14ac10 asyncio: Server.close() leaves client sockets open 2014-07-12 03:20:24 +02:00
Victor Stinner 8ebeb03740 asyncio: improve the documentation of servers
- Fix the documentation of Server.close(): it closes sockets
- Replace AbstractServer with Server
- Document Server.sockets attribute
2014-07-11 23:47:40 +02:00
Victor Stinner 778015b3bc asyncio: enhance documentation of platform support 2014-07-11 12:13:39 +02:00
Berker Peksag 740c730086 Issues #21948 and #16040: Fix typos. 2014-07-09 20:15:28 +03:00
Victor Stinner aea82293be Issue #21680: Document asyncio event loops 2014-07-08 23:42:38 +02:00
Victor Stinner 530ef2f069 Update asyncio documentation
- Document the new create_task() method
- "Hide" the Task class: point to the create_task() method for interoperability
- Rewrite the documentation of the Task class
- Document the "Pending task destroyed"
- Update output in debug mode of examples in the dev section
- Replace Task() with create_task() in examples
2014-07-08 12:39:10 +02:00
Victor Stinner 63b21a8ffa Closes #21921: Fix ResourceWarning in the asyncio examples: close the event
loop at exit. Patch written by Vajrasky Kok (I modified also the "hello world"
example using a coroutine).
2014-07-05 15:38:59 +02:00
Berker Peksag 5021cb553c Issue #21920: Add a missing colon to the __main__ doc.
Patch by Stefan Tatschner.
2014-07-05 11:10:16 +03:00
Berker Peksag 3410af45f8 Add an index entry for exec() builtin.
Reported by Draic Kin on docs@.
2014-07-04 15:06:45 +03:00
Raymond Hettinger 11cda47661 Fix guidance for subclassing collections.Set() 2014-07-03 00:31:30 +01:00
Andrew Svetlov ee750d8f8d Use try-finally idiom in example for locks in multiprocessing 2014-07-02 07:21:03 +03:00
Ned Deily 5c867018f0 Issue #21875: Remove vestigial references to Classic Mac OS in os module docs. 2014-06-26 23:40:06 -07:00
Jesus Cea 0c4baa40ec MERGE: Closes #20872: dbm/gdbm/ndbm close methods are not documented 2014-06-25 13:06:07 +02:00
Jesus Cea ac4b7f705a Closes #20872: dbm/gdbm/ndbm close methods are not documented 2014-06-25 13:05:31 +02:00
Senthil Kumaran 99597c4d12 Correct the quopri module documentation. Mention the correct types of the
parameters on encodestring and decodestring.

Patch by Petri Lehtinen.
2014-06-25 01:12:03 -07:00
Benjamin Peterson f6f78e1d9d clarify that islink only really works if python knows about symlinks (closes #13143)
Patch from Yayoi Ukai.
2014-06-22 17:59:35 -07:00
Benjamin Peterson 9b29acd1fe some timezone doc improvements (closes #16667)
From the combined efforts of Berber Peksage, Andrew Svetlov, and Yayoi Ukai.
2014-06-22 16:26:39 -07:00
Victor Stinner f328c7dc69 asyncio, Tulip issue 171: BaseEventLoop.close() now raises an exception if the
event loop is running. You must first stop the event loop and then wait until
it stopped, before closing it.
2014-06-23 01:02:37 +02:00
Victor Stinner 62511fd6d6 asyncio: document the debug mode 2014-06-23 00:36:11 +02:00
Victor Stinner 7b7120e159 asyncio: Enable the debug mode of event loops when the PYTHONASYNCIODEBUG
environment variable is set
2014-06-23 00:12:14 +02:00
Senthil Kumaran 4932e14542 issue 20091 - index entry for __main__ in runpy docs. 2014-06-20 01:37:53 -07:00
Ezio Melotti 642d4b654f #21690: fix a couple of links in the docs of the re module. Noticed by Julian Gilbey. 2014-06-20 00:52:11 +03:00
Victor Stinner d143209d7f Tulip issue 83: document more asyncio functions in docstrings 2014-06-19 17:11:49 +02:00
Victor Stinner 6bfd854ea8 Closes #21758: asyncio doc: mention explicitly that subprocess parameters are
bytes or character strings
2014-06-19 12:50:27 +02:00
Zachary Ware 8909127af2 Fix typo pointed out by cocoatomo on docs@ 2014-06-17 22:26:59 -05:00
Victor Stinner 64d750b36b asyncio: Fix pyflakes errors
- Add a missing import
- Remove an unused import
- Remove unused variables
2014-06-18 03:25:23 +02:00
Terry Jan Reedy b6d1f48c14 Issue #21559: Add alternative (historical) reason for OverflowError. 2014-06-16 03:31:00 -04:00