Commit Graph

7626 Commits

Author SHA1 Message Date
Raymond Hettinger 5f6209a3c6 merge 2016-03-13 00:12:49 -08:00
Raymond Hettinger a503f7092f Minor recipe edit: convert "while 1" to "while True". 2016-03-13 00:12:31 -08:00
Ezio Melotti 0ce835fc7e #25687: merge with 3.5. 2016-03-13 09:40:55 +02:00
Ezio Melotti 8dea74f12a #25687: clarify that errors in tearDown increase the total number of reported errors. Initial patch by HyeSoo Park. 2016-03-13 09:40:09 +02:00
Raymond Hettinger 7dc830e988 merge 2016-03-12 22:58:44 -08:00
Raymond Hettinger 4d02896609 Issue #26548: Minor fix to awkward wording in docs 2016-03-12 22:58:24 -08:00
Steve Dower 6d6b986d90 Issue #23606: Adds note to ctypes documentation regarding cdll.msvcrt. 2016-03-12 08:26:29 -08:00
Steve Dower d669b6bd0a Issue #23606: Adds note to ctypes documentation regarding cdll.msvcrt. 2016-03-12 08:25:22 -08:00
Berker Peksag eb2e02bed4 Issue #26542: Fix markup of code example in difflib documentation
Patch by Dmitry Shachnev.
2016-03-11 23:19:48 +02:00
Victor Stinner 2c2a4e63d7 Add Mock.assert_called()
Issue #26323: Add assert_called() and assert_called_once() methods to
unittest.mock.Mock.
2016-03-11 22:17:48 +01:00
Berker Peksag 82442b7022 Issue #26542: Fix markup of code example in difflib documentation
Patch by Dmitry Shachnev.
2016-03-11 23:20:09 +02:00
Martin Panter b9f3114d42 Issue #21042: Return full path in ctypes.util.find_library() on Linux
Patch by Tamás Bence Gedai.
2016-03-10 01:06:23 +00:00
Serhiy Storchaka 674e2d0ea0 Issue #15068: Got rid of excessive buffering in fileinput.
The bufsize parameter is now deprecated and ignored.
2016-03-08 18:35:19 +02:00
Serhiy Storchaka cc2dbc5844 Issue #15068: Got rid of excessive buffering in the fileinput module.
The bufsize parameter is no longer used.
2016-03-08 18:28:36 +02:00
Berker Peksag 5b96d66ac6 Issue #21034: Remove outdated paragraph from venv documentation
Since Python 3.4, there is no need to install pip and setuptools
into a venv manually.
2016-03-07 18:51:06 +02:00
Berker Peksag 777d639a92 Issue #21034: Remove outdated paragraph from venv documentation
Since Python 3.4, there is no need to install pip and setuptools
into a venv manually.
2016-03-07 18:50:49 +02:00
Raymond Hettinger 20b3e72b8d Merge 2016-03-06 18:12:08 -08:00
Raymond Hettinger e525ee3b48 Document another recipe for itertools: all_equal(). Inspired by David Beazley. 2016-03-06 18:11:38 -08:00
Alexander Belopolsky a2998a63c8 Closes #19475: Added timespec to the datetime.isoformat() method.
Added an optional argument timespec to the datetime isoformat() method
to choose the precision of the time component.

Original patch by Alessandro Cucci.
2016-03-06 14:58:43 -05:00
Berker Peksag 6282e656e9 Issue #26335: Make mmap.write() return the number of bytes written like
other write methods.

Patch by Jakub Stasiak.
2016-03-02 19:30:18 +02:00
Georg Brandl 3902d62c4e merge with 3.5 2016-02-26 19:37:52 +01:00
Georg Brandl 5d94134040 Closes #25910: fix dead and permanently redirected links in the docs. Thanks to SilentGhost for the patch. 2016-02-26 19:37:12 +01:00
Georg Brandl eb73563f48 merge with 3.5 2016-02-26 19:16:43 +01:00
Georg Brandl 32fbd3a623 Closes #26442: fix copy-paste. 2016-02-26 19:16:40 +01:00
Georg Brandl def4ff6a64 merge with 3.5 2016-02-26 19:14:56 +01:00
Georg Brandl adeffcc2f9 Closes #26444: typo fixes. 2016-02-26 19:13:47 +01:00
Martin Panter de9b27d908 Issue #26390: Merge pbkdf2_hmac() doc from 3.5 2016-02-26 00:41:38 +00:00
Georg Brandl 6d6dd73aec merge with 3.5 2016-02-25 20:18:00 +01:00
Georg Brandl 8c16cb9f65 Closes #26435: fix syntax in directives. Thanks to Jakub Stasiak. 2016-02-25 20:17:45 +01:00
Martin Panter 150ea1a1df Issue #22088: Merge base64 docs from 3.5 2016-02-24 01:08:43 +00:00
Martin Panter ee3074e1f4 Issue #22088: Clarify base-64 alphabets and which characters are discarded
* There are only two base-64 alphabets defined by the RFCs, not three
* Due to the internal translation, plus (+) and slash (/) are never discarded
* standard_ and urlsafe_b64decode() discard characters as well

Also update the doc strings to clarify data types, based on revision
92760d2edc9e, correct the exception raised by b16decode(), and correct the
parameter name for the base-85 functions.
2016-02-23 22:30:50 +00:00
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 bc85e35fe6 Issue #26390: Fix and test pbkdf2_hmac() parameter names
Based on patch by Daan Bakker.
2016-02-22 09:21:49 +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
Berker Peksag 0fe1b472ab Issue #26199: Fix broken link in unittest.mock-examples.rst
Patch by Raphael Das Gupta.
2016-01-28 08:40:21 +02:00
Berker Peksag a370a4271e Issue #26199: Fix broken link in unittest.mock-examples.rst
Patch by Raphael Das Gupta.
2016-01-28 08:40:03 +02:00
Raymond Hettinger 0ef0423cb2 merge 2016-01-26 21:46:03 -08:00
Raymond Hettinger 3743432302 Issue #26194: Fix undefined behavior for deque.insert() when len(d) == maxlen 2016-01-26 21:44:16 -08:00
Brett Cannon 52c854a838 Merge from 3.5 2016-01-22 14:05:41 -08:00
Brett Cannon 3bf1d87bbd Fix a typo in a code example 2016-01-22 14:03:27 -08:00
Senthil Kumaran cbde4a6924 merge from 3.5
minor clarification on Zipfile 'x' mode - exclusive creation of a file.

(Based on the feedback from docs@python.org list)
2016-01-21 21:08:25 -08:00
Senthil Kumaran e5c05cc8c0 minor clarification on Zipfile 'x' mode - exclusive creation of a file. 2016-01-21 21:06:47 -08:00
Berker Peksag 2e15d60b83 Issue #18620: Improve Pool examples in multiprocessing documentation
A single call to Pool.apply_async() will create only one process. To use all
of the pool's processes, it should be invoked multiple times:

    with Pool(processes=4) as pool:
        results = [pool.apply_async(func, ()) for i in range(4)]

Patch by Davin Potts.
2016-01-22 00:00:06 +02:00
Berker Peksag 7405c16533 Issue #18620: Improve Pool examples in multiprocessing documentation
A single call to Pool.apply_async() will create only one process. To use all
of the pool's processes, it should be invoked multiple times:

    with Pool(processes=4) as pool:
        results = [pool.apply_async(func, ()) for i in range(4)]

Patch by Davin Potts.
2016-01-21 23:59:49 +02:00
Senthil Kumaran 316fcc867b merge from 3.5
issue25982 - Add a class definition for managers.Namespace in the multiprocessing docs.
2016-01-20 03:11:52 -08:00
Senthil Kumaran 6a0514ea20 issue25982 - Add a class definition for managers.Namespace in the multiprocessing docs. 2016-01-20 03:10:13 -08:00
Berker Peksag 5d69e6871a Issue #5626: Remove misleading comment from socket.gethostname() documentation
A machine can have more than one IP addresses so
socket.gethostbyname(socket.gethostname()) probably won't return the correct
one.
2016-01-20 08:45:54 +02:00
Berker Peksag 744fdfbf9a Issue #5626: Remove misleading comment from socket.gethostname() documentation
A machine can have more than one IP addresses so
socket.gethostbyname(socket.gethostname()) probably won't return the correct
one.
2016-01-20 08:45:37 +02:00
Berker Peksag 4f49c1c38a Issue #26157: Fix typos in asyncio-eventloop.rst
Initial patch by Carlo Beccarini.
2016-01-20 07:14:43 +02:00
Berker Peksag 49c9edf3d9 Issue #26157: Fix typos in asyncio-eventloop.rst
Initial patch by Carlo Beccarini.
2016-01-20 07:14:22 +02:00
Senthil Kumaran 3114d763fb merge from 3.5
issue23962 - Reference the correct TimeoutError in concurrent.futures documentation.

Patch contributed by Ryder Lewis.
2016-01-18 18:45:54 -08:00
Senthil Kumaran 9e9f850f99 issue23962 - Reference the correct TimeoutError in concurrent.futures documentation.
Patch contributed by Ryder Lewis.
2016-01-18 18:45:00 -08:00
Serhiy Storchaka 9cc4ed5c7a Issue #26129: Deprecated accepting non-integers in grp.getgrgid(). 2016-01-18 18:49:57 +02:00
Ethan Furman 2ae4ea54a2 use public 'value' 2016-01-16 12:39:53 -08:00
Senthil Kumaran 7b3a82ff55 Merge from 3.5
Issue26035 - Correct the argument names used in the docs of the traceback module. Make it consistent with module args.

Patch contributed by Upendra Kumar.
2016-01-15 21:46:08 -08:00
Senthil Kumaran a82908f743 Issue26035 - Correct the argument names used in the docs of the traceback module. Make it consistent with module args.
Patch contributed by Upendra Kumar.
2016-01-15 21:45:17 -08:00
Martin Panter 2139a9fd27 Issue #26127: Merge tokenize documentation 2016-01-16 04:34:50 +00:00
Martin Panter 20b1bfa6fb Issue #26127: Fix links in tokenize documentation; patch by Silent Ghost 2016-01-16 04:32:52 +00:00
Ethan Furman 60255b67b9 revert change 87a9dff5106c: pure Enum members again evaluate to True;
update Finer Points section of docs to cover boolean evaluation;
add more tests for pure and mixed boolean evaluation
2016-01-15 15:01:33 -08:00
Ezio Melotti 997e6c1dd8 #19006: merge with 3.5. 2016-01-12 11:03:54 +02:00
Ezio Melotti f418db2e8c #19006: fix wording in unittest docs. 2016-01-12 11:03:31 +02:00
Yury Selivanov 9179c40a9f Merge 3.5 (issue #25486) 2016-01-11 21:05:18 -05:00
Yury Selivanov a7c159ddf3 Issue #25486: Drop "removed in 3.6" wording from inspect.getargspec docs. 2016-01-11 21:04:50 -05:00
Ezio Melotti d4d4f20284 #25991: merge with 3.5. 2016-01-11 23:31:38 +02:00
Ezio Melotti 7c018aa377 #25991: fix readline example to limit history size. Patch by Daniel Dye. 2016-01-11 23:30:56 +02:00
Yury Selivanov 37dc2b2883 Issue #25486: Resurrect inspect.getargspec in 3.6. Backout a565aad5d6e1.
The decision is that we shouldn't remove popular APIs (however long they
are depreacted) from Python 3, while 2.7 is still around and supported.
2016-01-11 15:15:01 -05:00
Andrew Svetlov f7272a667e merge 3.5 2016-01-11 15:42:05 +02:00
Andrew Svetlov ea471348f4 Fix versionadded to use 3.5.1 only for 3.5 branch 2016-01-11 15:41:43 +02:00
Andrew Svetlov 38bb42c132 merge 3.5 2016-01-11 14:45:49 +02:00
Andrew Svetlov 3af81f2505 merge 3.4 2016-01-11 14:45:25 +02:00
Andrew Svetlov f1240169b3 Document asyncio.timeout() 2016-01-11 14:40:35 +02:00
Benjamin Peterson 7e23fe1ce1 merge 3.5 (#26066) 2016-01-09 23:56:40 -08:00
Benjamin Peterson 4d927420b8 merge 3.4 (#26066) 2016-01-09 23:56:31 -08:00
Benjamin Peterson 6829dbbf3f delete old crypto prose (closes #26066) 2016-01-09 23:55:47 -08:00
Brett Cannon a85e927e39 Issue #25802: Add an examples section to importlib.
Thanks to Berker Peksag for the patch review.
2016-01-08 14:33:09 -08:00
Benjamin Peterson 3407473f91 merge 3.5 (#26046) 2016-01-07 22:02:13 -08:00
Benjamin Peterson e95fd0b411 merge 3.4 (#26046) 2016-01-07 22:02:01 -08:00
Benjamin Peterson 8a6ddb98e6 fix typo in unittest docs (closes #26046)
Patch from Upendra Kumar.
2016-01-07 22:01:26 -08:00
Berker Peksag d56e67e116 Issue #5501: Clarify that invoking freeze_support() on non-Windows platforms has no effect
Patch by Davin Potts and Camilla Montonen.
2016-01-07 18:45:47 +02:00
Berker Peksag 94541f464c Issue #5501: Clarify that invoking freeze_support() on non-Windows platforms has no effect
Patch by Davin Potts and Camilla Montonen.
2016-01-07 18:45:22 +02:00
Senthil Kumaran d68cc8416d merge from 3.5
Issue16544 - Add a link to an external documentation resource in ast module docs.
2016-01-06 21:31:09 -08:00
Senthil Kumaran 0deaf9ac30 merge from 3.4
Issue16544 - Add a link to an external documentation resource in ast module docs.
2016-01-06 21:30:30 -08:00
Senthil Kumaran f3695bfacf Issue16544 - Add a link to an external documentation resource in ast module docs. 2016-01-06 21:26:53 -08:00
Guido van Rossum f08a308ebb Docs for issue #22570. (Merge 3.5->3.6) 2016-01-06 11:37:52 -08:00
Guido van Rossum 1469d744bc Cross-reference os.DirEntry and pathlib.Path for issue #22570. 2016-01-06 11:36:03 -08:00
Guido van Rossum 05075203c5 Add versionadded (3.4.5) to docs for issue #22570. (Merge 3.4->3.5) 2016-01-06 11:26:36 -08:00
Guido van Rossum b1360543e5 Add versionadded (3.4.5) to docs for issue #22570. 2016-01-06 11:23:31 -08:00
Guido van Rossum 406005144b Docs for issue #22570. (Merge 3.4->3.5) 2016-01-06 11:16:28 -08:00
Guido van Rossum df85946e8a Docs for issue #22570. 2016-01-06 11:15:52 -08:00
Senthil Kumaran dcf76c9d0a merge from 3.5
Issue24898 - Improve str.find documentation.

Simplify str.find explaination as per Georg Brandl's suggestion.
2016-01-03 18:00:31 -08:00
Senthil Kumaran f34c3fe20c merge from 3.4
Issue24898 - Improve str.find documentation.

Simplify str.find explaination as per Georg Brandl's suggestion.
2016-01-03 17:58:24 -08:00
Senthil Kumaran 114a1d638e Issue24898 - Improve str.find documentation.
Simplify str.find explaination as per Georg Brandl's suggestion.
2016-01-03 17:57:10 -08:00
Senthil Kumaran 15777231e9 merge from 3.5
Issue21221 - Explain the usage of tm_isdst attribute of mktime, with valid
values and meaning.

Patch contributed by Andrew Scheller.
2016-01-03 00:45:05 -08:00
Senthil Kumaran 6ffbcdf13f merge from 3.4
Issue21221 - Explain the usage of tm_isdst attribute of mktime, with valid
values and meaning.

Patch contributed by Andrew Scheller.
2016-01-03 00:43:23 -08:00
Senthil Kumaran a880800363 Issue21221 - Explain the usage of tm_isdst attribute of mktime, with valid
values and meaning.

Patch contributed by Andrew Scheller.
2016-01-03 00:40:03 -08:00
R David Murray 75f104a745 #21815: Make the doc change match what I actually did. 2016-01-02 17:25:59 -05:00
R David Murray 317f64f048 #21815: violate IMAP RFC to be compatible with, e.g., gmail
and others, including imaplib's own behavior.  I'm applying this only to 3.6
because there's a potential backward compatibility concern: if there are
servers that include ] characters in the 'text' portion of their imap
responses, this code change could introduce a new bug.

Patch by Lita Cho, reviewed by Jessica McKellar, Berker Peksag, Maciej Szulik,
silentghost, and me (I fleshed out the comments with the additional
info/concerns.)
2016-01-02 17:18:34 -05:00
Senthil Kumaran 5b3455c793 merge from 3.5
Issue25917 : Fix howto links in docs. Point the reference documentation instead of wiki.
2016-01-01 23:27:38 -08:00
Senthil Kumaran fcb6db50d3 merge from 3.4
Issue25917 : Fix howto links in docs. Point the reference documentation instead of wiki.
2016-01-01 23:26:53 -08:00
Senthil Kumaran d03d1d45f5 Issue25917 : Fix howto links in docs. Point the reference documentation instead of wiki. 2016-01-01 23:25:58 -08:00
Zachary Ware bdce29b9a4 Merge with 3.5 2016-01-01 12:24:12 -06:00
Zachary Ware 46a78bc92c Fix grammar.
Reported by Anatoly Techtonik on docs@
2016-01-01 12:22:16 -06:00
Brett Cannon eae3079041 Issue #25802: Deprecate load_module() on importlib.machinery.SourceFileLoader and SourcelessFileLoader.
They were the only remaining implementations of load_module() not
documented as deprecated.
2015-12-28 17:55:27 -08:00
Brett Cannon 01f7ac3bb0 Backport of fix for issue #25930 2015-12-28 17:30:32 -08:00
Brett Cannon 050391774a Issue #25930: Document that os.unlink and os.remove are *semantically* identical.
Saying that the functions were identical confused some users who were
upset when the functions were no longer simply the same function under
different names.

Thanks to Anthony Sottile for the bug report and Swati Jaiswal for the
initial patch.
2015-12-28 17:28:19 -08:00
Stefan Krah 53f2e0ad45 Issue #25928: Add Decimal.as_integer_ratio(). Python parts and docs by
Mark Dickinson.
2015-12-28 23:02:02 +01:00
Brett Cannon 1e3c3e906c Issue #25768: Make compileall functions return booleans and document
the return values as well as test them.

Thanks to Nicholas Chammas for the bug report and initial patch.
2015-12-27 13:17:04 -08:00
R David Murray 2bd58e3991 Merge: #1753718: clarify RFC compliance and bytes/string argument types. 2015-12-23 21:19:53 -05:00
R David Murray a198645fa0 #1753718: clarify RFC compliance and bytes/string argument types.
Patch includes contributions by Isobel Hooper, incorporating suggestions from
Paul Winkler.  Reviewed by Martin Panter.

In addition to accepting the corrections for the RFC compliance wording, I
went through and corrected all the argument and return types, and made the
pattern of how the arguments and return types are documented consistent.
So, this patch also addresses #20782, though I had forgotten about that issue
and its patch.
2015-12-23 21:17:17 -05:00
Yury Selivanov 7f955ab16a Merge 3.5 2015-12-17 18:26:53 -05:00
Yury Selivanov 3dc74bf703 docs: Document ASYNC/AWAIT tokens (issue #25580)
Initial patch by SilentGhost
2015-12-17 18:26:41 -05:00
Yury Selivanov 90791ce220 Merge 3.5 2015-12-16 21:31:15 -05:00
Yury Selivanov 9920e293c3 Merge 3.4 2015-12-16 21:31:04 -05:00
Yury Selivanov cba0053bef docs/asyncio: Twek sections names per Nick Coghlan suggestion 2015-12-16 21:30:52 -05:00
Yury Selivanov f4f67e52b4 Merge 3.5 2015-12-15 00:45:39 -05:00
Yury Selivanov e319ab01ce docs/asyncio: Update ensure_future & run_coroutine_threadsafe docs 2015-12-15 00:45:24 -05:00
Gregory P. Smith 60889d1238 Issue #11072: change the incorrect "deprecation" of ftplib dir() and nlst()
APIs into a note that mlsd() is a nicer API if the server supports
it.  They aren't deprecated, they are all different server commands.
Not all servers support all commands.
2015-12-13 22:10:58 -08:00
Gregory P. Smith f1b3134d28 Issue #11072: change the incorrect "deprecation" of ftplib dir() and nlst()
APIs into a note that mlsd() is a nicer API if the server supports
it.  They aren't deprecated, they are all different server commands.
Not all servers support all commands.
2015-12-13 22:10:28 -08:00
R David Murray d991963a9d Merge: #25495: Clarify b2a_base64 documentation vis 57 bytes.
In 3.6 the parameter to control the appending of the newline was finally
added, so I dropped the historical note about why a new line was always
appended.
2015-12-13 18:11:07 -05:00
R David Murray 51a4b22f99 Merge: #25495: Clarify b2a_base64 documentation vis 57 bytes. 2015-12-13 18:04:56 -05:00
R David Murray 2b4f47ee35 #25495: Clarify b2a_base64 documentation vis 57 bytes. 2015-12-13 18:04:27 -05:00
Martin Panter 70fe09bc67 Issue #22341: Merge CRC doc from 3.5 2015-12-11 05:41:48 +00:00
Martin Panter b82032f935 Issue #22341: Drop Python 2 workaround and document CRC initial value
Also align the parameter naming in binascii to be consistent with zlib.
2015-12-11 05:19:29 +00:00
Martin Panter 8c0b5b998a Issue #14285: Merge runpy fix from 3.5 2015-12-11 03:35:31 +00:00
Martin Panter 7dda421bff Issue #14285: Do not catch exceptions initializing any ancestor package
The previous fix only handled the case of the parent package of __main__
failing to initialize.

Also make the "Error while finding spec" formatting slightly more appealing,
and document and test that the module name must be absolute.
2015-12-10 06:47:06 +00:00
Berker Peksag 2e7fca8e48 Issue #21240: Add an abstractmethod directive to mark abstract methods in the docs more explicitly 2015-12-08 12:15:19 +02:00
Berker Peksag 6e9d2e687b Issue #21240: Add an abstractmethod directive to mark abstract methods in the docs more explicitly 2015-12-08 12:14:50 +02:00
Brett Cannon aa3e69e57f Merge for issue #23936 2015-12-04 15:46:43 -08:00
Brett Cannon ccddbb186b Issue #23936: Clarify what finders are.
Thanks to Raúl Cumplido for the bug report and Thomas Kluyver for the
patch.
2015-12-04 15:46:21 -08:00
Zachary Ware df144092a3 Closes #25767: Merge with 3.5 2015-11-30 22:57:22 -06:00
Zachary Ware ee1a0e4b8c Issue #25767: Merge with 3.4 2015-11-30 22:57:01 -06:00
Zachary Ware 992bfe093e Issue #25767: Link to English Wikipedia instead of French. 2015-11-30 22:56:17 -06:00
Martin Panter b4ce1fc31b Issue #5319: New Py_FinalizeEx() API to exit with status 120 on failure 2015-11-30 03:18:29 +00:00
R David Murray 4f09806e66 #25485: Add context manager support to Telnet class.
Patch by Stéphane Wirtel.
2015-11-28 12:24:52 -05:00
Martin Panter 2ed41f305e Issue #22989, #21228: Merge urlopen() doc from 3.5 2015-11-26 11:04:06 +00:00
Martin Panter 9e87f3d79f Issue #22989, #21228: Merge urlopen() doc from 3.4 into 3.5 2015-11-26 11:03:50 +00:00
Martin Panter 747d48cf27 Issues #22989, #21228: Document HTTP response object for urlopen()
Previous documentation was not clear if the geturl(), info() and getcode()
were valid for HTTP responses. The “msg” attribute is different to the usual
HTTPResponse.msg attribute. Based on patch by Evens Fortuné.
2015-11-26 11:01:58 +00:00
Vinay Sajip e5beb3da00 Closes #25508: Merged documentation fix from 3.5. 2015-11-24 23:24:17 +00:00
Vinay Sajip 46cc4a8f32 Issue #25508: Merged documentation fix from 3.4. 2015-11-24 23:22:48 +00:00
Vinay Sajip 4f44d53770 Issue #25508: Clarify documentation on LogRecord args attribute. 2015-11-24 23:21:15 +00:00
Martin Panter a561c038ab Issue #25576: Merge www-form-urlencoded doc from 3.5 2015-11-24 22:59:28 +00:00
Martin Panter f7e8d07538 Issue #25576: Merge www-form-urlencoded doc from 3.4 into 3.5 2015-11-24 22:57:46 +00:00
Martin Panter cda85a0d1c Issue #25576: Remove application/x-www-form-urlencoded charset advice
No charset parameter is standardized for this Content-Type value. Also
clarify that urlencode() outputs ASCII.
2015-11-24 22:33:18 +00:00
Raymond Hettinger c880ef8d30 merge 2015-11-23 22:19:12 -08:00
Raymond Hettinger 6e701310d1 Issue #25700: Clarify that namedtuple property docstrings became writeable in 3.5 2015-11-23 22:18:55 -08:00
Serhiy Storchaka f50fe724de Issue #25706: Fixed markup in the documentation. 2015-11-23 16:44:30 +02:00
Serhiy Storchaka 1f847659f3 Issue #25706: Fixed markup in the documentation. 2015-11-23 16:43:54 +02:00
Serhiy Storchaka bf7b9ede1a Issue #25706: Fixed markup in the documentation. 2015-11-23 16:43:05 +02:00
Martin Panter d6a59bacd8 Issue #25689: Merge ftplib and nntplib docs from 3.5 2015-11-21 22:49:06 +00:00
Martin Panter 23244e5787 Issue #25689: Merge ftplib and nntplib docs from 3.4 into 3.5 2015-11-21 22:48:54 +00:00
Martin Panter 828123ce4e Issue #25689: Fix language in ftplib and nntplib docs
Original patch by Silent Ghost.
2015-11-21 22:03:08 +00:00
Ethan Furman 748dad5b6a Close 25594: advise against accessing Enum members from other members 2015-11-20 13:12:26 -08:00