Commit Graph

16593 Commits

Author SHA1 Message Date
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
Terry Jan Reedy 9cc9026294 Issue #21055: Index (augmented) assignment symbols. 2014-04-29 01:19:17 -04:00
Terry Jan Reedy 7c895edabc Closes 21048: Index 'as' in import and with statements. 2014-04-29 00:58:56 -04:00
Terry Jan Reedy 43e7cd38e5 Issue #21026: Augment site doc based on experiments. Patch by Carol Willing. 2014-04-29 00:31:53 -04:00
Antoine Pitrou f9f54a2f5f Issue #9307: document the various Py_TPFLAGS_*_SUBCLASS flags. Patch by Yury V. Zaytsev. 2014-04-29 01:39:03 +02:00
R David Murray ae25f46706 #18243: Remove obsolete cautionary note from email mktime_tz docs. 2014-04-26 19:01:18 -04:00
Benjamin Peterson 9e599673b4 fix off-by-one error (closes #21330) 2014-04-22 21:54:10 -04:00
Terry Jan Reedy bddecc3861 Issue #21232: Replace .splitlines arg '1' with 'keepends=True'. 2014-04-18 17:00:19 -04:00
Zachary Ware a37ff0fb80 Issue #21289: Fix documentation building on Windows using Doc/make.bat.
Also fixes a long-standing typo in Doc/README.txt.

Initial patch by Dave Sawyer.
2014-04-18 15:10:40 -05:00
Benjamin Peterson d065c48991 fix ref count annotations on sphinx >= 1.2.1 (closes #21286) 2014-04-17 18:29:01 -04:00
Senthil Kumaran aad7cc9dba Clarify BROWSER envar behavior in webbrowser.py. Noted by David Turner. Closes #21248 2014-04-16 23:43:34 -04:00
Senthil Kumaran 8b4a272c98 Correct the URL in the http.client example. Noted by Evens Fortuné. Closes #21229 2014-04-16 23:33:02 -04:00
R David Murray f7f981829b #18628: clarify index entry for source file encoding declaration.
Patch by Sam Lucidi.
2014-04-16 21:48:04 -04:00
Senthil Kumaran cad2bf20c3 Address issue 18229 - Explain http.server.BaseHTTPRequestHandler's .headers attribute further.
Initial patch by Caelyn McAulay.
2014-04-16 13:56:19 -04:00
Terry Jan Reedy 7f84d1eb63 #18566: Whitespace 2014-04-15 23:44:14 -04:00
Terry Jan Reedy 6ac4240b6c Issue #18566: Clarify unittest setUp, tearDown doc. Patch by Nitika Agarwal. 2014-04-15 23:38:18 -04:00
R David Murray fc1020d396 #20874: reflow paragraph. 2014-04-15 20:26:54 -04:00
R David Murray 0e0e391fa3 #20874: update tutorial wording: sophisticated line editing is now standard.
Patch by Rafael Mejia.
2014-04-15 20:25:18 -04:00
Vinay Sajip 65425b4bc6 Issue #21245: updated documentation on exception() method and function. 2014-04-15 23:13:12 +01:00
R David Murray fe0e1082aa #15104: add backtick code markup. 2014-04-14 18:53:51 -04:00
R David Murray 061cb3b04d #15104: improve the discussion of __main__.
Patch by Sam Lucidi.
2014-04-14 15:04:47 -04:00
Andrew Kuchling 44da19a63d #18518: mention that including a return statement changes/breaks the behaviour 2014-04-14 13:39:43 -04:00
Mark Dickinson abf079de25 Issue #20624: Exception docs wording tweak - clarify that it's okay to inherit from a subclass of Exception. 2014-04-14 11:20:12 -04:00
R David Murray 604453c9ce #21169: add comment and doc update for getpass change. 2014-04-14 10:28:58 -04:00
Eric V. Smith 04d8a245f1 Fix faq example with division. 2014-04-14 07:52:53 -04:00
Eric V. Smith fc9a4d828e Fix text about int() with octal numbers. Closes #21212. 2014-04-14 07:41:52 -04:00
Ned Deily ecd9e8ac67 Remove references to the obsolete Mac Carbon modules in the GUI
section of the FAQ.
2014-04-12 09:32:04 -07:00
Terry Jan Reedy f98021cff2 Issue #21170: Removed invalid parameter names from unittest doc.
Patch by Kushal Das.
2014-04-11 14:11:11 -04:00
Senthil Kumaran f3ddcc9ba7 issue #21190: Fix the broken docs download link 2014-04-09 11:44:34 -04:00
Yury Selivanov af8a4dfb04 docs: Better wording for __objclass__ docs. Issue #19281 2014-04-08 14:00:35 -04:00
Yury Selivanov d3f918ca44 docs: Document __objclass__. Closes #19281.
Initial patch by Nick Coghlan
2014-04-08 12:03:07 -04:00
Benjamin Peterson ce0700ae7a PySequence_Fast generally returns a list not a tuple (closes #16395) 2014-04-08 10:48:36 -04:00
Benjamin Peterson f0f7844f38 the name of the slot of nb_multiply not nb_mul 2014-04-08 10:44:30 -04:00
Benjamin Peterson 222ef82827 fix verb (closes #21174) 2014-04-07 19:34:33 -04:00
Senthil Kumaran 6d6ec25e04 merge from 3.3 2014-04-06 11:00:15 -07:00
Senthil Kumaran f5c34054f9 minor docfix (reported at docs@python.org) trace.py argument is --count not --counts 2014-04-06 10:59:47 -07:00
Brett Cannon 18fc4e70f3 Issue #20942: PyImport_ImportFrozenModuleObject() no longer sets
__file__.

This causes _frozen_importlib to no longer have __file__ set as well
as any frozen module imported using imp.init_frozen() (which is
deprecated).
2014-04-04 10:01:46 -04:00
Raymond Hettinger b30b34c1aa Issue 21143: Fix typo in docs for max(). 2014-04-03 08:01:22 -07:00
Eli Bendersky 0bd22d4277 Issue #20375: Clarify ET's parsing of comments and processing instructions.
Based on patch by Nikolaus Rath.
2014-04-03 06:14:38 -07:00
Raymond Hettinger 31b26f637a Issue #18652: Add an itertools recipe for first_true() 2014-04-02 03:16:42 -07:00
Raymond Hettinger f4284e45d0 Documentation nit. List the traditional keyword-only argument first and the default last. 2014-04-02 00:58:47 -07:00
Raymond Hettinger da4bf8f16a Issue 21125: minor documentation tweak. 2014-04-01 22:17:33 -07:00
Benjamin Peterson 1acc69c650 update version changed 2014-04-01 19:22:06 -04:00
Benjamin Peterson 9dc203fff9 merge 3.3 (#21082) 2014-04-01 19:18:48 -04:00
Benjamin Peterson 4717e2112b merge 3.2 (#21082) 2014-04-01 19:17:57 -04:00
Benjamin Peterson ee5f1c13d1 remove directory mode check from makedirs (closes #21082) 2014-04-01 19:13:18 -04:00
Zachary Ware 9d08562ed4 Issue #15067: Port 2.7 sqlite3 docs to 3.4 2014-04-01 12:21:56 -05:00
Andrew Svetlov c3bf6922b5 #16716: remove deprecation warning 2014-04-01 02:08:25 +03:00
Andrew Svetlov 08af00047b Get rid of deprecated IOError in the doc 2014-04-01 01:13:30 +03:00
Andrew Svetlov 5898d4f4d9 IOError -> OSError 2014-04-01 00:44:13 +03:00
Andrew Svetlov 050f9ea4d7 Fix the doc: add deprecation warning in select module. 2014-04-01 00:23:23 +03:00
Benjamin Peterson 3a4340325b make partialmethod example work (closes #21105) 2014-03-30 15:07:09 -04:00
Guido van Rossum 589872cbdf Fix doc typo. 2014-03-29 21:14:04 -07:00
Raymond Hettinger 1e1e601bd1 Minor readability improvement. 2014-03-29 11:50:08 -07:00
Nick Coghlan 9aa00d1cd1 Issue #19697: document more __main__.__spec__ quirks 2014-03-29 15:39:42 +10:00
Eric Snow e50f9aa4bd Issue #19697: Document cases where __main__.__spec__ is None. 2014-03-28 18:10:33 -06:00
Raymond Hettinger 4ab532bbfe Issue 21014: Use booleans instead of 0 and 1 in examples. 2014-03-28 16:39:25 -07:00
Georg Brandl 865bdbf4af Doc: do not compress .epub for dist, it is already zipped. 2014-03-28 19:48:55 +01:00
Ned Deily e7d532fbc9 Issue #6676: Ensure a meaningful exception is raised when attempting
to parse more than one XML document per pyexpat xmlparser instance.
(Original patches by Hirokazu Yamamoto and Amaury Forgeot d'Arc, with
suggested wording by David Gutteridge)
2014-03-27 16:39:58 -07:00
Victor Stinner 215ad66405 Issue #12209: Minor edits to faulthandler doc. Patch written by Éric Araujo. 2014-03-25 12:33:56 +01:00
Vinay Sajip 4908910ab7 Updated external link in documentation. 2014-03-25 11:21:41 +00:00
Georg Brandl 1afe2af690 Closes #21045: make the Qt help build not look completely stupid 2014-03-25 10:12:47 +01:00
Victor Stinner 984600fba7 Issue #21006: asyncio doc: reorganize subprocess doc 2014-03-25 09:40:26 +01:00
Georg Brandl 1c669c1154 Closes #18456: Doc fix: PyDict_Update only works with dict-like objects, not key-value sequences. Patch by priyapappachan. 2014-03-25 09:34:30 +01:00
Donald Stufft 4137465bf5 Issue #21043: Remove the recommendation for specific CA organizations
Closes #21043 by updating the documentation to remove specific CA
organizations and update the text to no longer need to tell you to
download root certificates, but instead use the OS certificates
avaialble through SSLContext.load_default_certs.
2014-03-24 19:26:03 -04:00
Georg Brandl df48b97855 Fix a few scoping issues with versionadded/versionchanged directives. 2014-03-24 09:06:18 +01:00
Zachary Ware 645d3b7655 Remove superfluous open parenthesis. Noticed by cocoatomo on docs@. 2014-03-23 22:21:38 -05:00
Donald Stufft 6a2ba94908 Issue #21013: Enhance ssl.create_default_context() for server side contexts
Closes #21013 by modfying ssl.create_default_context() to:

* Move the restricted ciphers to only apply when using
  ssl.Purpose.CLIENT_AUTH. The major difference between restricted and not
  is the lack of RC4 in the restricted. However there are servers that exist
  that only expose RC4 still.
* Switches the default protocol to ssl.PROTOCOL_SSLv23 so that the context
  will select TLS1.1 or TLS1.2 if it is available.
* Add ssl.OP_NO_SSLv3 by default to continue to block SSL3.0 sockets
* Add ssl.OP_SINGLE_DH_USE and ssl.OP_SINGLE_ECDG_USE to improve the security
  of the perfect forward secrecy
* Add ssl.OP_CIPHER_SERVER_PREFERENCE so that when used for a server side
  socket the context will prioritize our ciphers which have been carefully
  selected to maximize security and performance.
* Documents the failure conditions when a SSL3.0 connection is required so
  that end users can more easily determine if they need to unset
  ssl.OP_NO_SSLv3.
2014-03-23 19:05:28 -04:00
Georg Brandl 553e108fce tutorial: no "linux2" sys.platform on 3.x (thanks Arfrever) 2014-03-23 23:03:59 +01:00
Antoine Pitrou f8cbbbb652 Issue #20913: make it clear that create_default_context() also enables hostname checking 2014-03-23 16:31:08 +01:00
Georg Brandl 75c5ab49ed Closes #20975: make date in the interpreter banner a little more consistent 2014-03-22 20:38:11 +01:00
Antoine Pitrou c5e075ff03 Issue #20913: improve the SSL security considerations to first advocate using create_default_context(). 2014-03-22 18:19:11 +01:00
Donald Stufft 79ccaa2cad Issue #20995: Enhance default ciphers used by the ssl module
Closes #20995 by Enabling better security by prioritizing ciphers
such that:

* Prefer cipher suites that offer perfect forward secrecy (DHE/ECDHE)
* Prefer ECDHE over DHE for better performance
* Prefer any AES-GCM over any AES-CBC for better performance and security
* Then Use HIGH cipher suites as a fallback
* Then Use 3DES as fallback which is secure but slow
* Finally use RC4 as a fallback which is problematic but needed for
  compatibility some times.
* Disable NULL authentication, NULL encryption, and MD5 MACs for security
  reasons
2014-03-21 21:33:34 -04:00
Victor Stinner 51f3129ba2 Close #21010: Fix typo in asyncio doc. Patch written by Claudiu Popa. 2014-03-21 17:17:15 +01:00
Victor Stinner 6bc239619c Issue #21006: Fix subprocess example on Windows in asyncio doc 2014-03-21 11:56:40 +01:00
Victor Stinner 7280486ce3 Close #21005: Fix documentation of asyncio.subprocess.DEVNULL 2014-03-21 11:44:49 +01:00
Benjamin Peterson 409a1be6cf improve start default for relpath 2014-03-20 12:39:53 -05:00
Zachary Ware 2f31b4b577 Fix typos in Doc/faq/extending. Found by cocoatomo on docs@. 2014-03-20 10:16:09 -05:00
Zachary Ware dbd1c43e52 Fix spelling in enum docs.
"equivalant" was caught by Tobias Käs on docs@, "seperated" and "chartruese"
were discovered by a spell-checker.
2014-03-20 10:01:48 -05:00
Zachary Ware 253deed862 Add missing parenthesis. Found by cocoatomo on docs@. 2014-03-20 09:46:09 -05:00
Zachary Ware a22ae21db6 Fix parameter name in docs for os.makedirs and os.removedirs.
Pointed out by Colin Davis on docs@.
2014-03-20 09:42:01 -05:00
Zachary Ware 088639936d Issue #20966: Fix Tkinter Resources link 2014-03-18 09:19:18 -05:00
Georg Brandl f5c801fdca Fix option description that is a warning in new Sphinx versions. 2014-03-18 07:44:07 +01:00
Éric Araujo 0b1be1a3b1 Fix typo in example (#20963) 2014-03-17 16:48:13 -04:00
Jesus Cea 28a965ff71 Typo 2014-03-17 19:22:59 +01:00
Jesus Cea bdb8bb39dd Typo 2014-03-17 19:13:09 +01:00
Jesus Cea cec25b01ec Typo 2014-03-17 19:00:48 +01:00
R David Murray f93d3dfc50 closes #20960 2014-03-17 11:20:29 -04:00
Georg Brandl a7f48019d5 merge with 3.3 2014-03-17 07:36:51 +01:00
Georg Brandl 56d3a03f70 Update doc version switcher for 3.4/3.5. 2014-03-17 07:36:45 +01:00
Larry Hastings 3c5c56f3c0 Merged default into 3.4 branch. 3.4 branch is now effectively 3.4.1rc1. 2014-03-16 22:54:05 -07:00
Benjamin Peterson 2221f666eb merge 3.3 (#11448) 2014-03-16 15:56:24 -05:00
Benjamin Peterson a48d9eaa5c improve set_tunnel docs (closes #11448)
Patch by Ryan Kelly, karl, and Nikolaus Rath.
2014-03-16 15:55:39 -05:00
Victor Stinner 7bdf786e74 Issue #20950: Fix typo asyncio doc, wait() has no self parameter
self parameter is implicit. Mention also that communicate() and wait() are
coroutines.
2014-03-16 21:29:31 +01:00
Larry Hastings 3101b70762 Final documentation fixes for 3.4.0 final. 2014-03-15 22:43:17 -07:00
Larry Hastings cf1a3cd2c7 Release bump for 3.4.0 final. 2014-03-15 22:34:24 -07:00
Larry Hastings 0548f5c514 Regenerate pydoc_topics, fix markup errors, in preparation for 3.4.0 final. 2014-03-15 22:29:19 -07:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
Nick Coghlan ffa1f27950 Bring PEP 453 What's New entry up to date
We changed a few details of the pip integration over the course
of the Python 3.4 beta and release candidate cycle, but I hadn't
updated the What's New entry appropriately.

The Py2/Py3 split on POSIX and the generally challenges of
dealing with parallel installs means we haven't attained
complete consistency across all environments, but hopefully
this updated text is clearer about the end result.

Relevant to issue #20909.
2014-03-16 13:55:19 +10:00
R David Murray 01f2129249 whatsnew: Fix Features section title, use title/sentence case consistently.
closes #20931
2014-03-15 23:27:30 -04:00
Larry Hastings 34784e6bf7 Issue #20931: Fix other confusingly-worded heading. 2014-03-15 20:15:55 -07:00
Antoine Pitrou 8bc7ef63a4 Close #16665: improve documentation for hex(). Patch by Jessica McKellar. 2014-03-16 02:13:07 +01:00
R David Murray d5358b94d1 whatsnew: Clarify heading. 2014-03-15 21:15:18 -04:00
Antoine Pitrou 790bf0db77 Close #16665: improve documentation for hex(). Patch by Jessica McKellar. 2014-03-16 02:12:20 +01:00
Benjamin Peterson bbd392e9e2 merge 3.3 2014-03-15 15:24:10 -05:00
Benjamin Peterson 0392271073 send people to the right editors page (#20938) 2014-03-15 15:23:32 -05:00