Commit Graph

16598 Commits

Author SHA1 Message Date
Ezio Melotti 898eb82696 #20135: move FAQ about mutable default arguments to the programming FAQs page. 2014-07-06 20:53:27 +03: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
Andrew Svetlov 0d50af45b6 Update docs about tp_richcompare 2014-07-03 16:07:17 +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
Berker Peksag fd6400a47d Issue #13689: Remove a dead link from howto/urllib. 2014-07-01 06:02:42 +03:00
Stefan Krah bb458dbe59 Issue #21778: Clarify use of flags if PyBuffer_FillInfo() is used inside a
getbufferproc().
2014-06-30 00:15:45 +02:00
Ezio Melotti 680241ec99 Fix indentation and class name in socket howto example. 2014-06-27 16:34:14 +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
Vinay Sajip ab960f838c Fixed typo in documentation. 2014-06-25 07:30:46 +01:00
Jesus Cea ca5c7153de MERGE: Closes #21441: Reorder elements in documentation to match actual order in the code 2014-06-25 05:38:06 +02:00
Jesus Cea e8ef8b7a20 Closes #21441: Reorder elements in documentation to match actual order in the code 2014-06-25 05:37:17 +02:00
Raymond Hettinger 04ba0bb80c Issue #11974: Add tutorial section on class and instance variables
(Based on a patch from Renee Chu.)
2014-06-23 18:08:01 -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
Zachary Ware 0aecc18bab Fix typo reported by Jesse W on docs@ 2014-06-16 11:13:01 -05:00
Terry Jan Reedy b6d1f48c14 Issue #21559: Add alternative (historical) reason for OverflowError. 2014-06-16 03:31:00 -04:00
Terry Jan Reedy f2fb73f675 Issue #19362: Tweek len() doc and docstring to expand the indicated range of
arguments. Original patch by Gareth Rees.
2014-06-16 03:05:37 -04:00
Benjamin Peterson e58e0c7f33 clarify when the list of subdirectories is read (closes #13779) 2014-06-15 20:51:12 -07:00
Benjamin Peterson ef8abfc082 document IOBase.__del__'s behavior (closes #21764)
Patch from Nikolaus Rath.
2014-06-14 18:51:34 -07:00
Vinay Sajip e0d324d02b Issue #21752: Documented change to behaviour of logging.getLevelName(). 2014-06-14 09:26:26 +01:00
Terry Jan Reedy 6926e3e835 Issue #21726: Remove unnecessary and contextually wrong line. 2014-06-13 14:57:51 -04:00
Victor Stinner b2788fe854 Issue #16136: VMSError is done, bye bye VMS 2014-06-13 14:58:48 +02:00
Senthil Kumaran e9738239ba #21693 - Fix the broken link for pylons project. 2014-06-11 06:19:21 -07:00
Zachary Ware 5989511183 Issue #21688: Give informative error message when hhc.exe cannot be found.
Initial patch by Olive Kilburn.
2014-06-10 12:07:45 -05:00
Victor Stinner db74d982d4 Issue #21596: asyncio.wait(): mention that the sequence of futures must not
be empty.
2014-06-10 11:16:05 +02:00
Victor Stinner bb2fc5b2a5 Issue #21326: Add a new is_closed() method to asyncio.BaseEventLoop
Add BaseEventLoop._closed attribute and use it to check if the event loop was
closed or not, instead of checking different attributes in each subclass of
BaseEventLoop.

run_forever() and run_until_complete() methods now raise a RuntimeError('Event loop is
closed') exception if the event loop was closed.

BaseProactorEventLoop.close() now also cancels "accept futures".
2014-06-10 10:23:10 +02:00
Victor Stinner 15386652bf Issue #21700: Fix asyncio doc, add DatagramProtocol 2014-06-10 09:19:26 +02:00
R David Murray 6ceca4e3d8 #20903: clarify what happens when an smtp connection timeout occurs.
Patch by Milan Oberkirch.
2014-06-09 16:41:06 -04:00
Nick Coghlan b1f59cecc9 Issue #21569: Fix incorrect cross reference 2014-06-09 13:14:54 +10:00
Benjamin Peterson 96e0430dfb document TokenError and unclosed expression behavior (closes #12063)
Patch by Amandine Lee.
2014-06-07 17:47:41 -07:00
Benjamin Peterson 4bb09c8432 specify that getuid() returns the real uid (closes #10503)
Patch by εσχατοκυριος.
2014-06-07 13:50:34 -07:00
Benjamin Peterson 9b2731bfdd document the compress_level argument to tarfile.open (closes #21404)
Patch by Katherine Busch.
2014-06-07 12:45:37 -07:00
Nick Coghlan 024b2f52bf Issue #21569: sync Python 2.7 What's New with 2.7 version 2014-06-07 23:43:00 +10:00
Nick Coghlan 1462786f00 Issue #21667: Clarify string data model description 2014-06-07 23:21:14 +10:00
Zachary Ware 780b585fbc Quash extraneous quote. 2014-06-06 09:13:18 -05:00
R David Murray 2c0781853a #21662: fix typo, improve sentence flow
Patch by Steve Dougherty.
2014-06-05 15:31:56 -04:00
R David Murray 092135ebc8 #21653: fix doc for return type of sqlite3.Row.keys(). 2014-06-05 15:16:38 -04:00
Zachary Ware 66f305b1a0 Issue #21661: Fix typo. 2014-06-05 13:41:06 -05:00
Victor Stinner f9e49dd346 Tulip issue 83, Python issue #21252: Fill some XXX docstrings in asyncio 2014-06-05 12:06:44 +02:00
Zachary Ware 2f78b84c47 Issue #21439: Fix a couple of typos. 2014-06-03 09:32:40 -05:00
Senthil Kumaran 8dc3df1b60 Update references to Python docs in the sidebar index.
Patch contributed by Auke Willem Oosterhoff.
2014-06-02 22:58:13 -07:00
Terry Jan Reedy b52f876767 Issue 21533: Dicts take iterables, not iterators. Patch by Wolfgang Maier. 2014-06-02 20:42:56 -04:00
Victor Stinner 8d21357fb5 Issue #21601: Document asyncio.Task.cancel(). Initial patch written by Vajrasky
Kok.
2014-06-02 23:06:46 +02:00
Vinay Sajip e81c637bf8 Updated logging HOWTO section on optimization. 2014-06-02 00:30:48 +01:00
Benjamin Peterson a8195770fa give the correct fixer name (closes #21604) 2014-05-31 13:16:49 -07:00
Terry Jan Reedy 0edb5c1668 Issue #21593: (from StackOverflow) minor doc clarification for re.search. 2014-05-30 16:19:59 -04:00
Vinay Sajip c673a9ab87 Issue #21608: Updated HTTPHandler documentation. 2014-05-30 18:59:27 +01:00
Victor Stinner a5b257af22 Issue #21454: Fix asyncio.BaseEventLoop.connect_read_pipe doc
The function sets the the pipe to non-blocking mode.
2014-05-29 00:14:03 +02:00
Victor Stinner 28d0ae48e9 Issue #21376: document asyncio.TimeoutError 2014-05-29 00:04:57 +02:00
Raymond Hettinger aa7886dd3f Issue 21439: Minor issues in the reference manual.
(Contributed by Feliks Kluzniak.)
2014-05-26 22:20:37 -07:00
Benjamin Peterson 5e2c4d2de0 grammar and sentence flow fix 2014-05-26 15:48:12 -07:00
Benjamin Peterson f9ea5f39d8 format reST directive in the usual way 2014-05-26 15:45:14 -07:00
Benjamin Peterson 0d81d80f6e link to wikipedia description of cryptographic salt 2014-05-26 15:42:29 -07:00
Benjamin Peterson 0ccff4d3e1 oxford comma 2014-05-26 15:41:26 -07:00
Benjamin Peterson 419f1fa9bc fix typo in variable name (closes #21586) 2014-05-26 15:10:42 -07:00
Raymond Hettinger e8e2df3daa Issue 21558: Fix a typo in the contextlib docs 2014-05-25 18:06:04 -07:00
Nick Coghlan e1d54e5f8e Mention setuptools & wheel as key terms for distribution 2014-05-26 00:50:11 +10:00
Terry Jan Reedy e17de09101 Issue #21545: Add .pop example and tweak comment about pure mutation methods.
Patch prepared by David Harrigan.
2014-05-23 00:34:12 -04:00
Raymond Hettinger 7096e26983 Issue 21479: Fix markup for the TarFile.open() classmethod. 2014-05-23 03:46:52 +01:00
Raymond Hettinger f7f64f94b1 Issue 21198: Minor tarfile documentation bug. 2014-05-23 00:03:45 +01:00
Raymond Hettinger bd46e48381 Issue 21554: Repair an out-of-date tutorial example to reflect changes in shutil. 2014-05-22 23:37:09 +01:00
Raymond Hettinger ae4bab71e3 Don't grow strings by concatenation. Use ''.join() instead. 2014-05-18 21:02:25 +01:00
Antoine Pitrou 75e03388d8 Issue #21430: additions to the description of non-blocking SSL sockets 2014-05-18 00:55:13 +02:00
Antoine Pitrou 2d1ec06484 Issue #21364: remove recommendation of broken pattern. 2014-05-15 22:38:56 +02:00
Victor Stinner ef5b4e3dc3 Issue #21488: Fix doc of codecs.decode() and codecs.encode(), no keyword support.
Patch written by Brad Aylsworth.
2014-05-14 17:08:45 +02:00
R David Murray ae9d193dc4 #21347: use string not list in shell=True example.
Patch by Akira.
2014-05-14 10:09:52 -04:00
Jason R. Coombs 73308d6869 Merge doc change from 3.3 2014-05-12 22:41:15 -04:00
Jason R. Coombs 13266fb5c8 Update docs to reflect resurrection of Setuptools over Distribute 2014-05-12 22:40:49 -04:00
Eric Snow 08197a4616 Issue #21226: Set all attrs in PyImport_ExecCodeModuleObject. 2014-05-12 17:54:55 -06:00
Victor Stinner b0539b27d9 Issue #21485: remove unnecesary .flush() calls in the asyncio subprocess code
example
2014-05-12 23:25:09 +02:00
Gregory P. Smith 8e0aa051e6 Change all references to Unix to POSIX in the subprocess docs. It's
more accurate and sounds less like a strange tale of yore.
2014-05-11 13:28:35 -07:00
Gregory P. Smith 6436cba9db Remove the warning-soup from the subprocess documentation by adding
a Security Considerations section as preferred by both the devguide
and documentation users who do not wish to go insane.
2014-05-11 13:26:21 -07:00
Benjamin Peterson 5c8ce188ee remove confusing delete indexing (closes #21466) 2014-05-11 11:18:51 -07:00
Brett Cannon 062fcac9a4 Issue #21438: Document what loaders don't require a module name for
load_module().
2014-05-09 11:55:49 -04:00
Brett Cannon f26702b86e Issue #21157: Touch up imp docs to be more explicit about importlib
alternatives.
2014-05-09 10:37:31 -04:00
R David Murray a83ade1d60 #21300: fix typo 2014-05-08 10:05:47 -04:00
R David Murray e25244657c #21300: Clean up the docs for the email "policy" arguments. 2014-05-06 21:33:18 -04:00
Zachary Ware 9fafc9f79a Add prompts to interactive example.
This makes it match the new example below, and allows Sphinx's
"hide the prompts and output" feature to work.
2014-05-06 09:18:17 -05:00
Zachary Ware 8edd532026 Issue #21366: Document the fact that ``return`` in a ``finally`` clause
overrides a ``return`` in the ``try`` suite.
2014-05-06 09:07:13 -05:00
Guido van Rossum 5280d2e399 asyncio docs: ProactorEventLoop does not support SSL. 2014-05-05 07:34:56 -07:00
Gregory P. Smith d8ea56d26d Document the subprocess Popen.args attribute (issue21353) 2014-04-29 11:33:56 -07:00
Gregory P. Smith 024c5eecbc Document the subprocess Popen.args attribute (issue21353) 2014-04-29 11:33:23 -07:00
Zachary Ware a67b97f438 Issue #17386: Expand Doc/make.bat to be much more similar to Doc/Makefile 2014-04-29 09:45:33 -05:00
Zachary Ware 1de519c60d Issue #17386: Update Doc/README.txt to list all targets
supported by Doc/Makefile, as well as a bit of modernization,
cleanup, and notes about the difference between Unix and Windows.
2014-04-29 09:26:56 -05:00
Zachary Ware 9393fffa5f Issue #17386: List the 'htmlview' target in the Doc/Makefile help output. 2014-04-29 09:24:40 -05:00