Commit Graph

8481 Commits

Author SHA1 Message Date
Miss Islington (bot) 19b42fe97c Warn that compile() can crash when compiling to an AST object (GH-6043) (GH-6046)
(cherry picked from commit f7a6ff6fca)

Co-authored-by: Brett Cannon <brettcannon@users.noreply.github.com>
2018-03-09 13:40:39 -08:00
Miss Islington (bot) b316c44b01 bpo-32758: Warn that ast.parse() and ast.literal_eval() can segfault the interpreter (GH-5960) (GH-6042)
(cherry picked from commit 7a7f100eb3)

Co-authored-by: Brett Cannon <brettcannon@users.noreply.github.com>
2018-03-09 12:35:14 -08:00
Miss Islington (bot) 15425cf245
Fix some ipaddress documentation errors (GH-6021)
* fix a typo: documention -> documentation
* fix the type of IPv?Network.hostmask
* add documentation about IPv?Network.netmask
* fix IPv6Network constructor doc that extended netmasks are not supported
(cherry picked from commit e405096ea9)

Co-authored-by: Xiang Zhang <angwerzx@126.com>
2018-03-07 20:41:27 -08:00
Miss Islington (bot) 7592c0a686
bpo-32969: Expose some missing constants in zlib and fix the doc (GH-5988)
(cherry picked from commit bc3f2289b9)

Co-authored-by: Xiang Zhang <angwerzx@126.com>
2018-03-06 21:46:10 -08:00
Miss Islington (bot) bd92cfe632
Fix missing coroutine declaration in the asyncio documentation. (GH-5964)
(cherry picked from commit 13cfd57dcf)

Co-authored-by: Joongi Kim <me@daybreaker.info>
2018-03-03 13:23:31 -08:00
Serhiy Storchaka fbdd075c64
[3.6] bpo-32964: Reuse a testing implementation of the path protocol in tests. (GH-5930). (GH-5958)
(cherry picked from commit b21d155f57)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-03-03 14:19:29 +02:00
Barry Warsaw 86ea851346
Revert "[3.6] bpo-32303 - Consistency fixes for namespace loaders (GH-5481) (#5504)" (#5911)
This reverts commit a71397fb66.
2018-02-26 11:23:24 -08:00
animalize 1278c21f52 [3.6] bpo-32394: Remove some TCP options on older version Windows. (GH-5585) 2018-02-26 10:13:51 -08:00
Christian Heimes 48707a1baf
[3.6] bpo-30622: Improve NPN support detection (GH-5859) (#5861)
The ssl module now detects missing NPN support in LibreSSL.

Co-Authored-By: Bernard Spil <brnrd@FreeBSD.org>
Signed-off-by: Christian Heimes <christian@python.org>.
(cherry picked from commit 6cdb7954b0)

Co-authored-by: Christian Heimes <christian@python.org>
2018-02-25 10:20:47 +01:00
Miss Islington (bot) cffe0467ab
bpo-32923: Unittest doc: replace `whilst` with `while` (GH-5833)
`whilst` and `while` are both english words, `whilst` is not as commonly used.
This can be confusing to readers whose primary language is not english.
(cherry picked from commit 98f42aac23)

Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
2018-02-23 10:22:27 -08:00
Miss Islington (bot) f8a794c04c
bpo-32008: don't use PROTOCOL_TLSv1 in example (GH-5789)
It's bad form to pin to an old version of TLS. ssl.SSLContext has the right
protocol default, so let's not pass anyway.
(cherry picked from commit e9edee0b65)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2018-02-20 22:07:17 -08:00
Miss Islington (bot) 0150dc5894 bpo-28886: doc: Move deprecated abc decorators to separate section (GH-176)
(cherry picked from commit 52c6b89796)

Co-authored-by: Harshul jain <harshulrobo@gmail.com>
2018-02-21 14:24:37 +09:00
Miss Islington (bot) f2d2e6169e
DOC: fix documentation for copyright and credits (GH-5706)
Adapt documentation for `copyright` and `credits` to reality.  Previously, the documentation implied that all each of `copyright`,
`credits`, and `license`, would print a message to call the object in order to see the full text.  In reality, only `license` exhibits this
behaviour, and `copyright` and `credit` print their full text either when printed, displayed, or called.
(cherry picked from commit 243d6d7126)

Co-authored-by: Gerrit Holl <gerrit.holl@gmail.com>
2018-02-16 20:16:52 -08:00
Miss Islington (bot) 76591bc03a
bpo-32860: Fix a missing asterisk in the documentation for glob.iglob() (GH-5712)
(cherry picked from commit 6887d86e9a)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2018-02-16 19:58:11 -08:00
Miss Islington (bot) b93a52b136 bpo-27846: Delete incorrect note in base64 docs (GH-5666)
This note incorrectly stated that "Base64 has an expansion factor of 6
to 4" (it is actually 4 to 3). It was decided to remove the note.

(cherry picked from commit 88c38a4049)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2018-02-14 03:48:28 +03:00
Miss Islington (bot) 6708be744d
bpo-32720: Fixed the replacement field grammar documentation. (GH-5544) (GH-5547)
`arg_name` and `element_index` are defined as `digit`+ instead of `integer`.
(cherry picked from commit 7a561afd2c)

Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
2018-02-12 00:07:55 -08:00
Miss Islington (bot) 9d8c24b791 bpo-32800: Update link to w3c doc for xml default namespaces (GH-5609) GH-5612)
The new link is given in a red box on the old page.
(cherry picked from commit 8d1f2f4038)

Co-authored-by: sblondon <sblondon@users.noreply.github.com>
2018-02-10 19:42:22 -05:00
Miss Islington (bot) 7f95c8c319 bpo-6135: Fix subprocess.check_output doc to mention changes in 3.6 (GH-5564) (GH-5573)
Fixes the documentation for `subprocess.check_output()` not mentioning that the encoding and errors parameters were added in 3.6.
(cherry picked from commit fc1ce810f1)

Co-authored-by: Brice Gros <brice-gros@users.noreply.github.com>
2018-02-06 18:11:26 -08:00
Miss Islington (bot) 231fa23f3f Fix typo -- missing "not" (GH-5528) (GH-5531) 2018-02-04 10:16:33 -08:00
Miss Islington (bot) 3bd749b212 bpo-32720: Fixed the definition for width and precision in format mini-language doc (GH-5482) (GH-5525)
Changed the definition of width and precision from "integer" to "digit+" in format mini-language doc.
(cherry picked from commit 8b5fa289fd)

Co-authored-by: nathankerr96 <nathankerr96@gmail.com>
2018-02-04 01:26:16 -05:00
Terry Jan Reedy c90a5dec03
[3.6] bpo-32746: Fix multiple typos (GH-5144) (GH-5522)
Fix typos found by codespell in docs, docstrings, and comments.
Fixes for the following files were in post-3.6 code and not backported:
Lib/ctypes/_aix.py (new), Lib/test/test_concurrent_futures.py,
Modules/_asynciomodule.c, Modules/_pickle.c, Objects/obmalloc.c.

(cherry picked from commit c3d9508ff2)
2018-02-03 21:00:24 -05:00
Miss Islington (bot) 7eb3d1e7da bpo-32739: Show default value for rotate() (GH-5485) (GH-5515)
(cherry picked from commit 589c718a8e)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2018-02-03 10:27:40 -08:00
Barry Warsaw a71397fb66
[3.6] bpo-32303 - Consistency fixes for namespace loaders (GH-5481) (#5504)
* Make sure ``__spec__.loader`` matches ``__loader__`` for namespace packages.
* Make sure ``__spec__.origin` matches ``__file__`` for namespace packages.

https://bugs.python.org/issue32303
https://bugs.python.org/issue32305.
(cherry picked from commit bbbcf8693b)

Co-authored-by: Barry Warsaw <barry@python.org>
2018-02-02 23:21:14 -05:00
Terry Jan Reedy fbf8e823c0
[3.6] bpo-32614: Modify re examples to use a raw string to prevent wa… …rning (GH-5265) (GH-5500)
Modify RE examples in documentation to use raw strings to prevent DeprecationWarning.
Add text to REGEX HOWTO to highlight the deprecation.  Approved by Serhiy Storchaka.

(cherry picked from commit 66771422d0)
2018-02-02 17:37:30 -05:00
Serhiy Storchaka 8cf7ebb32d
[3.6] bpo-32565: Add missed versionadded directives for all new opcodes. (GH-5199). (GH-5471)
(cherry picked from commit 12e7cd8a51)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-02-01 14:47:22 +02:00
Miss Islington (bot) 04f99ba9d7 bpo-32701: Clarify the quotetabs flag in quopri documentation (GH-5401) (GH-5438)
(cherry picked from commit 9424dcbb3e)

Co-authored-by: Julien Palard <julien@palard.fr>
2018-01-29 20:16:21 -08:00
Miss Islington (bot) 190de183e5 Fix minor markup typo (GH-5407) (#5416)
(cherry picked from commit 2a3260bb03)
2018-01-29 01:24:09 -08:00
Miss Islington (bot) 196b8cbab2 bpo-32651 Recommend getpass.getuser() (GH-5301) (#5304)
* bpo-32651 - In the documentation for os.getlogin(), recommend getpass.getuser()
(cherry picked from commit d499031f5f)
2018-01-24 14:09:56 -05:00
Xiang Zhang fd844efa9c
bpo-17799: Explain real behaviour of sys.settrace and sys.setprofile (GH-4056) (#5298)
(cherry picked from commit 131fd7f96c)
2018-01-24 22:44:53 +08:00
Victor Stinner 5f959c4f9e
[3.6] bpo-31900: Fix localeconv() encoding for LC_NUMERIC (#4174) (#5192)
* Add _Py_GetLocaleconvNumeric() function: decode decimal_point and
  thousands_sep fields of localeconv() from the LC_NUMERIC encoding,
  rather than decoding from the LC_CTYPE encoding.
* Modify locale.localeconv() and "n" formatter of str.format() (for
  int, float and complex to use _Py_GetLocaleconvNumeric()
  internally.

(cherry picked from commit cb064fc232)
2018-01-15 23:23:47 +01:00
Miss Islington (bot) fb8569e36f bpo-26330: Update shutil.disk_usage() documentation (GH-5184) (GH-5188)
Clarify that on Windows, path must be a directory.
On Unix, path can be a file or a directory.
(cherry picked from commit ee3b83547c)
2018-01-15 06:32:11 -08:00
Miss Islington (bot) bb80645d06 bpo-15221: Update os.path.is*() documentation (GH-5185) (GH-5186)
`os.path.is*()` can return False if the file can't be accessed.
The behaviour is documented in details in `os.path.exists()`.
Link to `os.path.exists()` from `os.path.is*()`.
(cherry picked from commit b3dd18d403)
2018-01-14 21:44:49 -08:00
Miss Islington (bot) cf4cd4bccb Add itertools recipe for directly finding the n-th combination (GH-5161) (#5174)
(cherry picked from commit d37258dd2e)
2018-01-13 11:21:15 -08:00
Miss Islington (bot) 29b1aff718 Improve enum.Flag code example (GH-5167) (GH-5171)
The code example that demonstrate how to use enum.Flag was missing
the import of enum.auto.
(cherry picked from commit 0f31c74fcf)
2018-01-12 20:23:21 -08:00
Serhiy Storchaka 1e6d8525f9
bpo-32211: Document the existing bug in re.findall() and re.finditer(). (#4695) 2018-01-04 11:08:24 +02:00
Miss Islington (bot) 45588c6dd1 Fix trivial typo in pickle.rst (GH-4955) (#4958)
(cherry picked from commit a8d25a1645)
2017-12-21 11:11:06 +02:00
Miss Islington (bot) 4aa84e7285 bpo-32306: Clarify c.f.Executor.map() documentation (GH-4947) (#4948)
The built-in map() function collects function arguments lazily, but concurrent.futures.Executor.map() does so eagerly.
(cherry picked from commit a7a751dd7b)
2017-12-20 19:19:18 +01:00
Miss Islington (bot) dab4cf210c Minor wording tweak for itertools documentation (GH-4893) (#4894)
(cherry picked from commit 6693d7af66)
2017-12-15 13:28:50 -08:00
Miss Islington (bot) 77bf6da725 bpo-28393: Update encoding lookup docs wrt bpo-27938 (GH-4871) (#4881)
(cherry picked from commit 297fd876aa)
2017-12-15 15:23:24 +01:00
Miss Islington (bot) 4a97809a38 trivial: link updates in documentation (GH-2765) (#4835)
(cherry picked from commit 4f29f3c84b)
2017-12-13 14:45:19 +02:00
Miss Islington (bot) b0358e8784 bpo-32284: Fix documentation of BinaryIO and TextIO (GH-4832) (#4833)
(cherry picked from commit c3e070f849)
2017-12-13 10:59:01 +02:00
Miss Islington (bot) 78cd00b799 bpo-31942: Document optional support of start and stop attributes in Sequence.index method (GH-4277) (#4811)
(cherry picked from commit 5ce0a2a100)
2017-12-12 11:58:26 +01:00
Miss Islington (bot) 0aa2a1d003 bpo-22671: Clarify and test default read method implementations (GH-4568) (#4796)
Original patch written by Martin Panter, enhanced by Sanyam Khurana.
(cherry picked from commit 1b74f9b77a)
2017-12-11 15:27:25 +01:00
Vinay Sajip 63868181a9
bpo-32212: Updated logging documentation to make parameter names more consistent with source. (GH-4765) (GH-4767)
(cherry picked from commit a9f8df646a)
2017-12-09 12:28:16 +00:00
Miss Islington (bot) a04ca12e12 bpo-32208: update threading.Semaphore docs and add unit test (GH-4709) (#4750)
* fix issue32208: update threading.Semaphore docs and add unit test to validate correct behavior

* add test for blocking

* Update threading.rst

* semaphore: remove documentation validation tests and move 'return value' test to BaseSemaphore
(cherry picked from commit a0374dd34a)
2017-12-07 20:48:35 +02:00
Miss Islington (bot) 3b55416700 Add a missing space in tkinter documentation. (GH-4692) (GH-4722)
(cherry picked from commit ae342cf7de)
2017-12-04 21:16:20 -08:00
Miss Islington (bot) 5f6d2bb8cf Use raw strings in the re module examples. (GH-4616) (#4617)
(cherry picked from commit c615be5166)
2017-11-28 23:21:09 +02:00
Miss Islington (bot) 8a957534f5 bpo-32051: Fix name shadowing in multiprocessing docs (GH-4469)
(cherry picked from commit c172fc5031)
2017-11-27 04:22:50 +03:00
Miss Islington (bot) cceb0f8d7b bpo-29879: Update typing documentation. (GH-4573) (GH-4574)
- Add "version added: 3.5.2" note where it was missing.
- Remove the mention that Reversible is new in 3.5.2
(cherry picked from commit 0cd2e81bea)
2017-11-26 14:27:44 -08:00
Miss Islington (bot) 6bce8ace76 [Doc] Update opcode for var-positional arguments (GH-4446) (#4457)
`BUILD_MAP_UNPACK_WITH_CALL` was duplicated as the opcode for both var-positional and var-keyword arguments. The opcode for the former was updated as `BUILD_TUPLE_UNPACK_WITH_CALL`.
(cherry picked from commit 0c71653cb8)
2017-11-25 17:57:41 +02:00