Commit Graph

18784 Commits

Author SHA1 Message Date
Zachary Ware c483a01a8f Issue #27206: Fix doctests in Doc/tutorial.
Patch by Jelle Zijlstra.
2016-08-09 17:44:52 -05:00
Zachary Ware 2b52c0a25f Issue #27205: Fix doctests in Doc/library/collections.rst.
Initial patch by Jelle Zijlstra.
2016-08-09 17:38:22 -05:00
Zachary Ware 7a26da5845 Issue #27722: Fix default for touch method's 'mode' argument 2016-08-09 17:10:39 -05:00
Zachary Ware 378a1d77d9 Issue #27204: Fix doctests in Doc/howto
Patch by Jelle Zijlstra.
2016-08-09 16:47:04 -05:00
Zachary Ware 2f47fb0021 Correct signatures for a couple of logging handlers
Reported by Oleg Gromyak on docs@
2016-08-09 16:20:41 -05:00
Guido van Rossum f68afd8544 Issue #27700: Document AbstractEventLoop, not BaseEventLoop. 2016-08-08 09:41:21 -07:00
Berker Peksag 08d85ee78d Fix use of default reST role 2016-08-08 13:34:49 +03:00
Berker Peksag 7d1c5efed1 Issue #23322: Remove outdated reference to an example in parser docs
Initial patch by Sahil Chelaramani.
2016-08-08 13:07:08 +03:00
Andrew Svetlov 4365b8302d Use asyncio.gather instead of asyncio.wait in example.
gather will raise exception in case of problem but wait just returns done and pending lists of futures.
For getting error every future result should be retrieved, which is boring and error prone.
2016-08-08 03:10:39 +03:00
Guido van Rossum abfe28b012 Better docs for typing.Any by Michael Lee. Fixes issue #27688. 2016-08-06 13:46:48 -07:00
Berker Peksag ab75e02f5c Issue #18548: Fix unittest.TestSuite() example
Initial patch by py.user.
2016-08-06 03:00:03 +03:00
Guido van Rossum b858af61b9 Add typing.Generator docs, by Michael Lee. 2016-08-05 12:56:09 -07:00
Martin Panter 69332c1a64 Fix spelling and grammar in documentation and code comments 2016-08-04 13:07:31 +00:00
Zachary Ware 72e483aac4 Fix half-finished sentence.
Reported by Linda Pescatore on docs@.
2016-08-04 12:13:47 -05:00
Berker Peksag 85b6090768 Fix indentation of versionadded directive in IPv4Address.reverse_pointer docs 2016-08-04 17:25:40 +03:00
Berker Peksag 6bbc83986d Indent ipaddress.ip_address() example correctly 2016-08-04 17:21:46 +03:00
Martin Panter 6c7d5a2553 Issue #24278: Explain how argument parsing output buffers are managed 2016-08-03 14:35:05 +00:00
Berker Peksag bed6891c77 Issue #23710: Update PyObject_HEAD documentation
Since PEP 3123, PyObject_HEAD only has one field named ob_base.
Users now need to use the Py_TYPE macro instead of self->ob_type.

Initial patch by Ammar Askar.
2016-08-03 12:58:49 +03:00
Berker Peksag 6cafececbf Issue #26576: Clarify that the @deco syntax is not always an equivalent of f = deco(f)
Patch by Chris Angelico.
2016-08-03 10:17:21 +03:00
Senthil Kumaran 17742f2d45 [merge from 3.4] - Prevent HTTPoxy attack (CVE-2016-1000110)
Ignore the HTTP_PROXY variable when REQUEST_METHOD environment is set, which
indicates that the script is in CGI mode.

Issue #27568 Reported and patch contributed by Rémi Rampin.
2016-07-30 23:39:06 -07:00
Senthil Kumaran 436fe5a447 [merge from 3.3] Prevent HTTPoxy attack (CVE-2016-1000110)
Ignore the HTTP_PROXY variable when REQUEST_METHOD environment is set, which
indicates that the script is in CGI mode.

Issue #27568 Reported and patch contributed by Rémi Rampin.
2016-07-30 23:34:34 -07:00
Senthil Kumaran 4cbb23f8f2 Prevent HTTPoxy attack (CVE-2016-1000110)
Ignore the HTTP_PROXY variable when REQUEST_METHOD environment is set, which
indicates that the script is in CGI mode.

Issue #27568 Reported and patch contributed by Rémi Rampin.
2016-07-30 23:24:16 -07:00
Berker Peksag fa95068081 Silence another "default role used" warning in typing.rst
This should make ware-docs green again.
2016-07-30 03:47:52 +03:00
Guido van Rossum c301cbf445 Fix whitespace. 2016-07-29 15:41:17 -07:00
Guido van Rossum 342e800e97 Expand documentation about type aliases and NewType in the typing module.
By Michael Lee.
2016-07-29 15:38:14 -07:00
Martin Panter 1050d2d0c7 Issue #26462: Doc: reduce literal_block warnings, fix syntax highlighting.
Patch by Julien Palard.
2016-07-26 11:18:21 +02:00
Zachary Ware 87ec85f420 Correct typo in Windows docs.
Found by Jack Copper on docs@
2016-07-28 19:00:53 -05:00
Martin Panter eb9957065a Issue #27626: Spelling fixes in docs, comments and internal names
Based on patch by Ville Skyttä.
2016-07-28 01:11:04 +00:00
Berker Peksag 25539b089f Issue #27633: Fix usage of versionchanged directive in email.parser.rst
Patch by Florian Preinstorfer.
2016-07-27 13:32:54 +03:00
Martin Panter 254da19d0e Issue #26638: Don’t link 2to3 -l option to the tarfile -l option 2016-07-26 06:46:06 +00:00
Berker Peksag aa46bd461c Issue #27601: Improve example in the "Hashing of numeric types" section
* Fix return value of hash_compute() implementation
* Rename variable names to hash_value to improve readability

Patch by Emanuel Barry.
2016-07-25 04:55:51 +03:00
Martin Panter 84544c1020 Issue #27130: Fix handling of buffers exceeding UINT_MAX in “zlib” module
Patch by Xiang Zhang.
2016-07-23 03:02:07 +00:00
Zachary Ware 48e3f98206 Issue #25393: Fix probable copy/paste error in resource docs
Patch by Alakshendra Yadav.
2016-07-19 16:41:20 -05:00
Martin Panter 221945056d Issue #27528: Document and test warning messages must match at beginning 2016-07-19 02:26:38 +00:00
Berker Peksag ebf9fd31a8 Issue #27531: Update signature of Mock.assert_not_called method
Since 01ae1ac2daf4, it doesn't accept any arguments.

Patch by Michael Killough.
2016-07-17 15:26:46 +03:00
Brett Cannon 9305bba203 Issue #26696: Document collections.abc.ByteString.
Thanks to Xiang Zhang for the patch.
2016-07-15 12:16:18 -07:00
Berker Peksag 2b8792137b Issue #27180: Clarify Path.rename() behavior on Unix systems
Patch by Evelyn Mitchell.
2016-07-14 07:44:59 +03:00
Berker Peksag 3093bf163b Issue #27455: Improve examples in tkinter documentation
Patch by John Hagen.
2016-07-14 07:32:43 +03:00
Serhiy Storchaka 6f379f4886 Issue #27481: Docummented that ValueError is now raised instead of TypeError
in case of embedded null characters/bytes.  Patch by Xiang Zhang.
2016-07-12 09:14:15 +03:00
Martin Panter 204bf0b9ae English spelling and grammar fixes 2016-07-11 07:51:37 +00:00
R David Murray 7a139c50db #26176: fix usage of Address constructor in email examples.
Patch by Nathan Harold.
2016-07-10 13:59:01 -04:00
Berker Peksag e75ffa965b Add versionadded to PyDict_SetDefault documentation
It was added for Python 3.4 in a0b750ea3397.
2016-07-05 17:08:29 +03:00
Berker Peksag 8faca61fec Issue #27431: Update default protocol version in shelve.Shelf() documentation
shelve.open() documentation was updated in f351fb7ea179.
2016-07-01 12:33:00 +03:00
Berker Peksag e39682b076 Issue #27430: Fix typos, patch by scop. 2016-07-01 12:17:05 +03:00
Serhiy Storchaka 15287f8bcc Issue #4945: Improved the documenting of boolean arguments in the json module.
Based on patch by Gabriel Genellina.
2016-06-30 13:59:12 +03:00
Victor Stinner 0ab67dfb7c Issue #27416: clarify copy doc
Patch written by R. David Murray.
2016-06-30 11:50:23 +02:00
Guido van Rossum 457509826e Fix issue #27402: example for typing did not type-check. 2016-06-28 10:08:17 -07:00
Berker Peksag 6803f35acc Issue #27393: Fix escaping of C:\ too 2016-06-27 13:10:47 +03:00
Berker Peksag 9c1e9d453c Issue #27393: Fix escaping of venv activate commands on Windows
Patch by Manuel Kaufmann.
2016-06-27 09:51:40 +03:00
Brett Cannon 559ad5d401 Remove a stale reference to pathlib.PurePath.path 2016-06-24 12:22:14 -07:00
Berker Peksag a064382925 Issue #27381: Remove superfluous paren in zipfile documentation 2016-06-24 12:56:50 +03:00
Berker Peksag 37e87e6ec1 Issue #26547: Remove outdated term dictproxy from vars() documentation
dictproxy was used in Python 2 and it was renamed to mappingproxy
in Python 3.3.

Patch by Julien.
2016-06-24 09:12:01 +03:00
Berker Peksag 79af27ef2e Issue #27378: Remove an outdated reference from regex HOWTO
Patch by Matt Morrison.
2016-06-24 08:54:43 +03:00
Terry Jan Reedy dcb6c88a24 Issue #27304: Source code links for sub-packages in the same file.
Patch by Yoni Lavi
2016-06-22 22:46:34 -04:00
Benjamin Peterson 8550bd80ae alter header; '%' really throws latex through a loop 2016-06-21 23:47:16 -07:00
Martin Panter 2275e626b1 Fix spelling errors in code comments 2016-06-20 07:52:50 +00:00
Serhiy Storchaka 514f9736a7 Issue #27294: Numerical state in the repr for Tkinter event objects is now
represented as a compination of known flags.
2016-06-18 22:08:11 +03:00
Senthil Kumaran d37de3c41d issue27021 - Document SC_IOV_MAX limitation imposed by OS on os.writev.
Patch contributed Марк Коренберг.
2016-06-18 11:21:50 -07:00
Martin Panter bae5d81f5d Issue #24314: Fix doc links for general attributes like __name__, __dict__ 2016-06-18 03:57:31 +00:00
Ned Deily dccc5edfa1 Issue #27327: fix doc typo, noted by Jakub Wilk. 2016-06-15 18:06:32 -04:00
Berker Peksag 33e7ca78f9 Make faq/general.rst gender-inclusive, patch by Sam Hathaway. 2016-06-15 18:12:49 +03:00
Georg Brandl b14f0c6409 merge with 3.4 2016-06-15 08:58:00 +02:00
Georg Brandl 4b9e75ba7f Docs: add html-stable autobuild variant 2016-06-15 08:57:32 +02:00
Martin Panter 71e86367e0 Issue #27311: Fix ZipFile.writestr data argument name.
Patch by John Hagen.
2016-06-15 00:24:34 +00:00
Berker Peksag 48b13f0427 Delete outdated paragraph about OptimizedUnicode again
sqlite3.OptimizedUnicode is an alias for str in Python 3 and
its behavior is already tested in CheckOptimizedUnicode in
Lib/sqlite3/test/factory.py.

sqlite3.OptimizedUnicode was undocumented in 0fc10a33eb4c and
probably added back with the result of a bad merge.
2016-06-14 12:51:07 +03:00
Martin Panter 6afbc653a7 Issue #16182: set_pre_input_hook() may not exist; document, and update test 2016-06-14 08:45:43 +00:00
Berker Peksag 9748478086 Issue #27306: Fix typo in tarfile documentation
Patch by Gareth Rees.
2016-06-14 00:48:35 +03:00
Berker Peksag 8f95e65e5d Issue #15657: Delete incorrect statement from PyMethodDef documentation 2016-06-12 16:34:38 +03:00
Berker Peksag c415440faa Issue #27188: Fix various sqlite3 documentation errors
* Connection.execute* methods don't create intermediate cursor objects
* Fix description of seq_of_parameters parameter
* Clarify that Warning is sqlite3.Warning
* sql_script parameter of Cursor.executescript() doesn't accept bytes
* Add missing tests
* Fix various markup errors

Initial patch by Dave Sawyer.
2016-06-12 13:41:47 +03:00
Berker Peksag 00eaa8a53b Use exc role for ValueError in multiprocessing.rst 2016-06-12 12:25:43 +03:00
Berker Peksag 0b19e1e72c Issue #27221: Delete an outdated paragraph about pickle support of Process
Initial patch by Jelle Zijlstra.
2016-06-12 12:19:13 +03:00
Martin Panter 70c502aacf Fix typos and English grammar in documentation and code comment 2016-06-12 06:14:03 +00:00
Martin Panter 0c0da48aed Issue #24136: Document generalized unpacking, PEP 448
Based on patches by Konstantin Molchanov and Neil Girdhar.
2016-06-12 01:46:50 +00:00
Berker Peksag af51140fa0 Fix typo and silence a Sphinx warning in Doc/glossary.rst 2016-06-11 22:40:41 +03:00
Berker Peksag 326196047f Silence 'make suspicious' warnings 2016-06-11 22:38:33 +03:00
Terry Jan Reedy fa089b9b0b Issue #22558: Add remaining doc links to source code for Python-coded modules.
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
Berker Peksag 420e4d843b Issue #27280: Fix typo in IPv6Network documentation
Patch by Arthur Carcano.
2016-06-10 14:26:07 +03:00
Tommy Beadle 63b91e5403 Issue #24617: Add comment for os.mkdir about mode quirks 2016-06-02 15:41:20 -04:00
Martin Panter 553245c6f5 Issue #8491: Add link to Gnu Readline configuration documentation 2016-06-10 00:27:46 +00:00
Tommy Beadle e9b8403a1f [Issue 15476] Make "code object" its own entry in the index 2016-06-02 19:26:51 -04:00
Yury Selivanov a6f6edbda8 Issue #27243: Fix __aiter__ protocol 2016-06-09 15:08:31 -04:00
Yury Selivanov c1cf296de6 asyncio: Remove asyncio.timeout() context manager.
It will probably be added back in Python 3.6, once its compatibility
issues are resolved; see [1] for more details.

[1] https://mail.python.org/pipermail/async-sig/2016-June/000045.html
2016-06-08 13:57:03 -04:00
Yury Selivanov af74512e44 asyncio: Update whatsnew/3.5.2 2016-06-08 12:55:29 -04:00
Yury Selivanov 55c5084223 Issue #27136: Update asyncio docs 2016-06-08 12:48:15 -04:00
Martin Panter 7d7a11b5d7 Issue #23275: Backport target list assignment documentation fixes 2016-06-08 12:44:30 +00:00
Berker Peksag 84f387d420 Issue #21593: Clarify that re.search() returns the first match 2016-06-08 14:56:56 +03:00
Martin Panter e42e129ebe Issue #25738: Don’t send message body for 205 Reset Content
Patch by Susumu Koshiba.
2016-06-08 08:29:13 +00:00
Victor Stinner dddf4849ec os.urandom() doesn't block on Linux anymore
Issue #26839: On Linux, os.urandom() now calls getrandom() with GRND_NONBLOCK
to fall back on reading /dev/urandom if the urandom entropy pool is not
initialized yet. Patch written by Colm Buckley.
2016-06-07 11:21:42 +02:00
Ned Deily 8f5798edfb Issue #26014: Update 3.x packaging documentation:
- "See also" links to the new docs are now provided in the legacy pages
- links to setuptools documentation have been updated

(original patch by Susan Sun)
2016-06-05 17:38:48 -07:00
Martin Panter ed0425c60a Issue #24291: Avoid WSGIRequestHandler doing partial writes
If the underlying send() method indicates a partial write, such as when the
call is interrupted to handle a signal, the server would silently drop the
remaining data.

Also add deprecated support for SimpleHandler.stdout.write() doing partial
writes.
2016-06-05 06:28:55 +00:00
Senthil Kumaran 889f914edb issue27202 - Fix the mistake in changesets 70af472451cb (3.5) and 2bb806539ca6 (3.6)
exclude_patterns in Sphinx conf.py will exclude the .rsts from the build. It
was incorrect exclude 2.x rsts in that.  This fix contributed again Jelle
Zijlstra, excludes doctests in whatsnew/2.7.rst from being exercised by using
doctests skip option.
2016-06-04 22:22:26 -07:00
Berker Peksag 03fe0027fb Issue #17888: Add a note about contributing to Python docs
Patch by Terry Chia and Laura Rupprecht.
2016-06-04 21:47:44 -07:00
Senthil Kumaran ff6c5c5466 issue27202 - Exclude 2.x release notes from python3 make doctests.
Patch contributed by Jelle Zijlstra.
2016-06-04 20:52:57 -07:00
Senthil Kumaran 7749320142 Issue27203 - Fix doctests Doc/faq/programming.rst.
Patch contributed by Jelle Zijlstra.
2016-06-04 20:07:34 -07:00
Kushal Das 89beb27061 Issue #19234: Documents socket.fileno() returns -1 on failure 2016-06-04 10:20:12 -07:00
Ned Deily 32db43867c Issue 27216: Fix typo (noticed by Alex Chan). 2016-06-04 09:40:40 -07:00
Martin Panter 3ee6270262 Fix typos in code comment and documentation 2016-06-04 04:57:19 +00:00
R David Murray 21dcb932a7 #22797: clarify when URLErrors are raised by urlopen. 2016-06-03 13:29:17 -04:00
Senthil Kumaran 7ee91942b4 issue27113 - Document "check_same_thread" parameter in sqlite3.connect api.
Patch contributed by Dave Sawyer.
2016-06-03 00:03:48 -07:00
Senthil Kumaran 0779129302 issue8519 - Reference termios and ioctl manual pages in the library documentation. 2016-06-02 23:49:05 -07:00