Commit graph

7443 commits

Author SHA1 Message Date
Martin Panter
fe93283fe1 Issue #26261: Merge NamedTemporaryFile docs from 3.5 2016-02-22 10:10:55 +00:00
Martin Panter
1f0e1f3cbb Issue #26261: Clarify NamedTemporaryFile name attribute vs file.name 2016-02-22 10:10:00 +00:00
Martin Panter
0d34530fe0 Merge XML-RPC client documentation from 3.5 2016-02-22 09:05:19 +00:00
Martin Panter
1c5e715d8f Fix errors in XML-RPC client example code
* http.client.HTTP (does not exist in Python 3) → HTTPConnection
* Server (deprecated) → ServerProxy
* Transport.send_request() grew a new “debug” parameter in Python 3 (revision
  a528f7f8f97a)
2016-02-22 09:04:22 +00:00
Berker Peksag
42b33a4d14 Issue #26401: Fix compile() documentation
After 25032ec29315, compile() will raise a ValueError
if source contains null bytes.

Patch by SilentGhost.
2016-02-21 22:00:29 +02:00
Berker Peksag
0334c3c735 Issue #26401: Fix compile() documentation
After 25032ec29315, compile() will raise a ValueError
if source contains null bytes.

Patch by SilentGhost.
2016-02-21 22:00:12 +02:00
Martin Panter
d9108d1253 Issue #23430: Stop socketserver from catching SystemExit etc from handlers
Also make handle_error() consistently output to stderr, and fix the
documentation.
2016-02-21 08:49:56 +00:00
Brett Cannon
86a8be00ed Fix a name in an example 2016-02-20 18:47:09 -08:00
Brett Cannon
4cbab346df Issue #26397: Update an importlib example to use util.module_from_spec() instead of create_module() 2016-02-20 18:45:56 -08:00
Brett Cannon
fe1941ebf8 Merge w/ 3.5 2016-02-20 18:40:18 -08:00
Brett Cannon
27c712e149 List what classes from importlib.machinery don't work with importlib.util.LazyLoader 2016-02-20 18:40:02 -08:00
Martin Panter
2d2d08d2cc Issue #22468: Merge gettarinfo() doc from 3.5 2016-02-19 23:46:59 +00:00
Martin Panter
f817a48d17 Issues #22468, #21996, #22208: Clarify gettarinfo() and TarInfo usage
* The Windows-specific binary notice was probably a Python 2 thing
* Make it more obvious gettarinfo() is based on stat(), and that non-ordinary
  files may need special care
* The file name must be text; suggest dummy arcname as a workaround
* Indicate TarInfo may be used directly, not just via gettarinfo()
2016-02-19 23:34:56 +00:00
Georg Brandl
7db1d16209 merge with 3.5 2016-02-19 08:57:50 +01:00
Georg Brandl
92849d1721 Closes #20169: fix inner links random doc. 2016-02-19 08:57:38 +01:00
Martin Panter
be1aec752d Issue #15608: Merge socketserver doc from 3.5 2016-02-19 03:35:00 +00:00
Martin Panter
eac17b8955 Issue #15608: Improve socketserver module documentation
* Add headings for each concrete and mix-in class and list methods and
  attributes under them
* Fix class and method cross references
* Changed RequestHandler to BaseRequestHandler and added class heading
* Pull out Stream/DatagramRequestHandler definitions
* Reordered the request handler setup(), handle(), finish() methods
* Document constructor parameters for the server classes
* Remove version 2.6 not relevant for Python 3 documentation
2016-02-19 03:27:46 +00:00
Berker Peksag
31a252b7f3 Issue #16915: Clarify that mode parameter of socket.makefile() does not accept
the same values as open().
2016-02-18 17:34:32 +02:00
Berker Peksag
3fe64d0c5c Issue #16915: Clarify that mode parameter of socket.makefile() does not accept
the same values as open().
2016-02-18 17:34:00 +02:00
Ned Deily
5ab2699c28 Issue #26368: fix typo in asynchio stream doc, reported by Ryan Stuart. 2016-02-16 13:27:45 +11:00
Ned Deily
f38c93fb7f Issue #26368: fix typo in asynchio stream doc, reported by Ryan Stuart. 2016-02-16 13:27:04 +11:00
Martin Panter
bc1ee460dc Issue #25179: Documentation for formatted string literals aka f-strings
Some of the inspiration and wording is taken from the text of PEP 498 by Eric
V. Smith, and the existing str.format() documentation.
2016-02-13 00:41:37 +00:00
Serhiy Storchaka
ffe96ae10b Issue #25994: Added the close() method and the support of the context manager
protocol for the os.scandir() iterator.
2016-02-11 13:21:30 +02:00
Serhiy Storchaka
885bdc4946 Issue #25985: sys.version_info is now used instead of sys.version
to format short Python version.
2016-02-11 13:10:36 +02:00
Guido van Rossum
e93b06a0a3 Hopefully clarify the difference between Optional[t] and an optional argument. 2016-02-10 09:48:58 -08:00
Guido van Rossum
3fb5612e08 Hopefully clarify the difference between Optional[t] and an optional argument. 2016-02-10 09:46:56 -08:00
Martin Panter
3008b1c4bb Issue #26304: Merge doc wording from 3.5 2016-02-10 05:44:56 +00:00
Martin Panter
c04fb56e36 Issue #26304: Change "allows to <verb>" to "allows <verb>ing" or similar
The original form is incorrect grammar and feels awkward, even though the
meaning is clear.
2016-02-10 05:44:01 +00:00
Martin Panter
1fe0d13d12 Issue #26243: zlib.compress() keyword argument support by Aviv Palivoda 2016-02-10 10:06:36 +00:00
Martin Panter
96a4f07107 Issues #26310, #26311: Fix typos in the documentation and code comments 2016-02-10 01:17:51 +00:00
Martin Panter
263c448a2e Issues #26310, 26311: Merge typo fixes from 3.5 2016-02-10 01:18:36 +00:00
Gregory P. Smith
b8e5eb31ea Clarify "cardinality of" as "number of elements in" as many readers do
not have a math vocabulary.
2016-02-08 09:59:00 -08:00
Gregory P. Smith
e27403b75f Clarify "cardinality of" as "number of elements in" as many readers do
not have a math vocabulary.
2016-02-08 09:58:40 -08:00
Martin Panter
d5db14794b Issue #25179: Preparatory cleanup of existing docs on string formatting
* Various sections were pointing to the section on the string.Formatter
  class, when the section on the common format string syntax is probably more
  appropriate
* Fix references to various format() functions and methods
* Nested replacement fields may contain conversions and format specifiers,
  and this is tested; see Issue #19729 for instance
2016-02-08 01:34:09 +00:00
Serhiy Storchaka
503f908090 Issue #26039: Added zipfile.ZipInfo.from_file() and zipinfo.ZipInfo.is_dir().
Patch by Thomas Kluyver.
2016-02-08 00:02:25 +02:00
Martin Panter
46988d3659 Merge string formatting doc fixes from 3.5 2016-02-08 01:49:35 +00:00
Zachary Ware
71e8134f20 Merge with 3.5 2016-02-02 17:04:56 -06:00
Zachary Ware
3df11b2bd6 Fix typo.
Reported by Jon Tetlak on docs@
2016-02-02 17:04:41 -06:00
Martin Panter
8254f793c0 Issue #26244: Merge zlib documentation from 3.5 2016-02-03 07:52:06 +00:00
Martin Panter
567d513b9b Issue #26244: Clarify default zlib compression level in documentation
Based on patch by Aviv Palivoda.
2016-02-03 07:06:33 +00:00
Raymond Hettinger
a63897164e merge 2016-02-01 21:21:19 -08:00
Raymond Hettinger
b00da57561 Issue #26194: Inserting into a full deque to raise an IndexError 2016-02-01 21:19:22 -08:00
Victor Stinner
59fe937c50 Merge 3.5 (doc) 2016-01-31 18:36:52 +01:00
Victor Stinner
5f0c5d92ef Enhance os.scandir() doc
Issue #26248, patch written by Ben Hoyt:

1) Clarify that the return values of is_dir()/is_file()/etc are cached
   separately for follow_symlinks True and False.
2) Be more specific about when the functions require a system call, and how it
   relates to caching and follow_symlinks.
3) DRY up common stuff between is_dir and is_file by saying "Caching, system
   calls made, and exceptions raised are as per is_dir" in is_file.
4) Tweak to the first paragraph of docs for is_dir/is_file to simplify: assume
   the follow_symlinks=True default, then note the follow_symlinks=False
   non-default case after.
2016-01-31 18:36:41 +01:00
Berker Peksag
89e54338d0 Issue #26242: Fix another one in importlib.rst 2016-01-30 19:30:22 +02:00
Berker Peksag
fe5f614418 Issue #26242: Fix another one in importlib.rst 2016-01-30 19:30:06 +02:00
Berker Peksag
da7e0d8b78 Fix a markup error in socket.rst 2016-01-30 19:23:46 +02:00
Berker Peksag
253739daf4 Fix a markup error in socket.rst 2016-01-30 19:23:29 +02:00
Martin Panter
9d48869fcc Issue #19023: Merge ctypes doc and tests from 3.5 2016-01-29 10:25:40 +00:00
Martin Panter
34360c8e09 Issue #19023: Document ctypes array and pointer classes
Also add some more tests. Based on patch by Sye van der Veen.
2016-01-29 10:12:19 +00:00