summaryrefslogtreecommitdiffstats
path: root/Doc/library
Commit message (Collapse)AuthorAgeFilesLines
* bpo-33045: Fix typos in SSL documentation (GH-6065)Miss Islington (bot)2018-03-111-2/+2
| | | | | (cherry picked from commit 9cf8c42f3231d3f066670d087a997bd1278482a0) Co-authored-by: Matt Eaton <agnosticdev@gmail.com>
* bpo-26701: Add documentation for __trunc__ (GH-6050)Miss Islington (bot)2018-03-102-3/+6
| | | | | | | `int` fails back to `__trunc__` is `__int__` isn't defined, so cover that in the docs. (cherry picked from commit 308eab979d153f1ab934383dc08bc4546ced8b6c) Co-authored-by: Eric Appelt <eric.appelt@gmail.com>
* Warn that compile() can crash when compiling to an AST object (GH-6043) ↵Miss Islington (bot)2018-03-091-0/+6
| | | | | | | (GH-6046) (cherry picked from commit f7a6ff6fcab32a53f262ba3f8a072c27afc330d7) Co-authored-by: Brett Cannon <brettcannon@users.noreply.github.com>
* bpo-32758: Warn that ast.parse() and ast.literal_eval() can segfault the ↵Miss Islington (bot)2018-03-091-0/+10
| | | | | | | interpreter (GH-5960) (GH-6042) (cherry picked from commit 7a7f100eb352d08938ee0f5ba59c18f56dc4a7b5) Co-authored-by: Brett Cannon <brettcannon@users.noreply.github.com>
* Fix some ipaddress documentation errors (GH-6021)Miss Islington (bot)2018-03-081-8/+12
| | | | | | | | | * 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 e405096ea91f516d411095b6fea4eec9668eac88) Co-authored-by: Xiang Zhang <angwerzx@126.com>
* bpo-32969: Expose some missing constants in zlib and fix the doc (GH-5988)Miss Islington (bot)2018-03-071-19/+22
| | | | | (cherry picked from commit bc3f2289b9007396bfb7f986bee477b6176c1822) Co-authored-by: Xiang Zhang <angwerzx@126.com>
* Fix missing coroutine declaration in the asyncio documentation. (GH-5964)Miss Islington (bot)2018-03-031-1/+1
| | | | | (cherry picked from commit 13cfd57dcf58485d6242fd8118c6ea4b10e29aab) Co-authored-by: Joongi Kim <me@daybreaker.info>
* [3.6] bpo-32964: Reuse a testing implementation of the path protocol in ↵Serhiy Storchaka2018-03-031-0/+7
| | | | | | | tests. (GH-5930). (GH-5958) (cherry picked from commit b21d155f57d284aecf9092a9bd24258293965c2f) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* Revert "[3.6] bpo-32303 - Consistency fixes for namespace loaders (GH-5481) ↵Barry Warsaw2018-02-261-1/+1
| | | | | (#5504)" (#5911) This reverts commit a71397fb6603d0fe673acd7765c74699cd28fe7b.
* [3.6] bpo-32394: Remove some TCP options on older version Windows. (GH-5585)animalize2018-02-261-0/+4
|
* [3.6] bpo-30622: Improve NPN support detection (GH-5859) (#5861)Christian Heimes2018-02-251-0/+17
| | | | | | | | | 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 6cdb7954b0a578d899e4b78b868ea59eef08480a) Co-authored-by: Christian Heimes <christian@python.org>
* bpo-32923: Unittest doc: replace `whilst` with `while` (GH-5833)Miss Islington (bot)2018-02-231-1/+1
| | | | | | | `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 98f42aac23f3863973cb6e9964c5212cfd3a1d98) Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
* bpo-32008: don't use PROTOCOL_TLSv1 in example (GH-5789)Miss Islington (bot)2018-02-211-2/+2
| | | | | | | 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 e9edee0b65650c4f9db90cefc2e9a8125bad762c) Co-authored-by: Benjamin Peterson <benjamin@python.org>
* bpo-28886: doc: Move deprecated abc decorators to separate section (GH-176)Miss Islington (bot)2018-02-211-22/+17
| | | | | (cherry picked from commit 52c6b89796a7ec391db20281e05b256f57e97b35) Co-authored-by: Harshul jain <harshulrobo@gmail.com>
* DOC: fix documentation for copyright and credits (GH-5706)Miss Islington (bot)2018-02-171-3/+7
| | | | | | | | 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 243d6d71265be1996a8326002deae429106a5fba) Co-authored-by: Gerrit Holl <gerrit.holl@gmail.com>
* bpo-32860: Fix a missing asterisk in the documentation for glob.iglob() ↵Miss Islington (bot)2018-02-171-1/+1
| | | | | | | (GH-5712) (cherry picked from commit 6887d86e9a04b9c5718b08e5d9e1ca3cc1f53721) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-27846: Delete incorrect note in base64 docs (GH-5666)Miss Islington (bot)2018-02-141-8/+0
| | | | | | | | 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 88c38a4049ded0e1f197fec3e76be7c0c0e83d7a) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-32720: Fixed the replacement field grammar documentation. (GH-5544) ↵Miss Islington (bot)2018-02-121-2/+2
| | | | | | | | (GH-5547) `arg_name` and `element_index` are defined as `digit`+ instead of `integer`. (cherry picked from commit 7a561afd2c79f63a6008843b83733911d07f0119) Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
* bpo-32800: Update link to w3c doc for xml default namespaces (GH-5609) GH-5612)Miss Islington (bot)2018-02-111-1/+1
| | | | | | The new link is given in a red box on the old page. (cherry picked from commit 8d1f2f40389c476d9240ec87a33da0373597c6af) Co-authored-by: sblondon <sblondon@users.noreply.github.com>
* bpo-6135: Fix subprocess.check_output doc to mention changes in 3.6 ↵Miss Islington (bot)2018-02-071-0/+3
| | | | | | | | (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 fc1ce810f1da593648b4d19e7d582a235ec1dd37) Co-authored-by: Brice Gros <brice-gros@users.noreply.github.com>
* Fix typo -- missing "not" (GH-5528) (GH-5531)Miss Islington (bot)2018-02-041-1/+1
|
* bpo-32720: Fixed the definition for width and precision in format ↵Miss Islington (bot)2018-02-041-2/+2
| | | | | | | | 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 8b5fa289fdb04b6b919cf95fa99246aa872e47a8) Co-authored-by: nathankerr96 <nathankerr96@gmail.com>
* [3.6] bpo-32746: Fix multiple typos (GH-5144) (GH-5522)Terry Jan Reedy2018-02-042-3/+2
| | | | | | | | | 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 c3d9508ff22ece9a96892b628dd5813e2fb0cd80)
* bpo-32739: Show default value for rotate() (GH-5485) (GH-5515)Miss Islington (bot)2018-02-031-4/+7
| | | | | (cherry picked from commit 589c718a8e3bde017350f248f7f1c009240eb52b) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* [3.6] bpo-32303 - Consistency fixes for namespace loaders (GH-5481) (#5504)Barry Warsaw2018-02-031-1/+1
| | | | | | | | | | * 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 bbbcf8693b876daae4469765aa62f8924f39a7d2) Co-authored-by: Barry Warsaw <barry@python.org>
* [3.6] bpo-32614: Modify re examples to use a raw string to prevent wa… ↵Terry Jan Reedy2018-02-021-1/+1
| | | | | | | | | …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 66771422d0541289d0b1287bc3c28e8b5609f6b4)
* [3.6] bpo-32565: Add missed versionadded directives for all new opcodes. ↵Serhiy Storchaka2018-02-011-0/+32
| | | | | | | (GH-5199). (GH-5471) (cherry picked from commit 12e7cd8a51956a5ce373aac692ae6366c5f86584) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* bpo-32701: Clarify the quotetabs flag in quopri documentation (GH-5401) ↵Miss Islington (bot)2018-01-301-3/+4
| | | | | | | (GH-5438) (cherry picked from commit 9424dcbb3e20a26dfdd81659303b989f7d3da044) Co-authored-by: Julien Palard <julien@palard.fr>
* Fix minor markup typo (GH-5407) (#5416)Miss Islington (bot)2018-01-291-1/+1
| | | (cherry picked from commit 2a3260bb030b0d4620242110c0ee5abc379afa8d)
* bpo-32651 Recommend getpass.getuser() (GH-5301) (#5304)Miss Islington (bot)2018-01-242-8/+11
| | | | * bpo-32651 - In the documentation for os.getlogin(), recommend getpass.getuser() (cherry picked from commit d499031f5f33c3ef71be7c81ef52eee6b47c42e1)
* bpo-17799: Explain real behaviour of sys.settrace and sys.setprofile ↵Xiang Zhang2018-01-241-17/+32
| | | | | (GH-4056) (#5298) (cherry picked from commit 131fd7f96c619bc7eaea956e45c6337175f4b27f)
* [3.6] bpo-31900: Fix localeconv() encoding for LC_NUMERIC (#4174) (#5192)Victor Stinner2018-01-152-0/+24
| | | | | | | | | | * 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 cb064fc2321ce8673fe365e9ef60445a27657f54)
* bpo-26330: Update shutil.disk_usage() documentation (GH-5184) (GH-5188)Miss Islington (bot)2018-01-151-1/+2
| | | | | Clarify that on Windows, path must be a directory. On Unix, path can be a file or a directory. (cherry picked from commit ee3b83547c6b0cac1da2cb44aaaea533a1d1bbc8)
* bpo-15221: Update os.path.is*() documentation (GH-5185) (GH-5186)Miss Islington (bot)2018-01-151-6/+9
| | | | | | `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 b3dd18d4035803b50c65a434955966d1b3b1f363)
* Add itertools recipe for directly finding the n-th combination (GH-5161) (#5174)Miss Islington (bot)2018-01-131-0/+23
| | | (cherry picked from commit d37258dd2e189141906bd234385096cd8e885d8d)
* Improve enum.Flag code example (GH-5167) (GH-5171)Miss Islington (bot)2018-01-131-1/+1
| | | | | The code example that demonstrate how to use enum.Flag was missing the import of enum.auto. (cherry picked from commit 0f31c74fcfdec8f9e6157de2c366f2273de81677)
* bpo-32211: Document the existing bug in re.findall() and re.finditer(). (#4695)Serhiy Storchaka2018-01-041-4/+10
|
* Fix trivial typo in pickle.rst (GH-4955) (#4958)Miss Islington (bot)2017-12-211-1/+1
| | | (cherry picked from commit a8d25a16452f7ee8dfc350cd028b3ae172d28ada)
* bpo-32306: Clarify c.f.Executor.map() documentation (GH-4947) (#4948)Miss Islington (bot)2017-12-201-13/+21
| | | | The built-in map() function collects function arguments lazily, but concurrent.futures.Executor.map() does so eagerly. (cherry picked from commit a7a751dd7b08a5bb6cb399c1b2a6ca7b24aba51d)
* Minor wording tweak for itertools documentation (GH-4893) (#4894)Miss Islington (bot)2017-12-151-2/+2
| | | (cherry picked from commit 6693d7af6670f8bda331e0b63bb77fce2e3efe9c)
* bpo-28393: Update encoding lookup docs wrt bpo-27938 (GH-4871) (#4881)Miss Islington (bot)2017-12-151-4/+8
| | | (cherry picked from commit 297fd876aad8ef443d8992618de22c46dbda258b)
* trivial: link updates in documentation (GH-2765) (#4835)Miss Islington (bot)2017-12-132-3/+3
| | | (cherry picked from commit 4f29f3c84b74de8c208980a14bc56bffa6363121)
* bpo-32284: Fix documentation of BinaryIO and TextIO (GH-4832) (#4833)Miss Islington (bot)2017-12-131-3/+3
| | | (cherry picked from commit c3e070f84931c847d1b35e7fb36aa71edd6215f6)
* bpo-31942: Document optional support of start and stop attributes in ↵Miss Islington (bot)2017-12-121-3/+3
| | | | | Sequence.index method (GH-4277) (#4811) (cherry picked from commit 5ce0a2a100909104836f53a2c8823006ec46f8ad)
* bpo-22671: Clarify and test default read method implementations (GH-4568) ↵Miss Islington (bot)2017-12-111-5/+8
| | | | | | (#4796) Original patch written by Martin Panter, enhanced by Sanyam Khurana. (cherry picked from commit 1b74f9b77a6fa1d7828986cb79d5b10942ff9141)
* bpo-32212: Updated logging documentation to make parameter names more ↵Vinay Sajip2017-12-091-236/+251
| | | | | consistent with source. (GH-4765) (GH-4767) (cherry picked from commit a9f8df646aac7fc94ced0aefd1ed2c8566d14d10)
* bpo-32208: update threading.Semaphore docs and add unit test (GH-4709) (#4750)Miss Islington (bot)2017-12-071-13/+13
| | | | | | | | | | * 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 a0374dd34aa25f0895195d388b5ceff43b121b00)
* Add a missing space in tkinter documentation. (GH-4692) (GH-4722)Miss Islington (bot)2017-12-051-1/+1
| | | (cherry picked from commit ae342cf7deebdcf2035f4064609b32b2102dadcf)
* Use raw strings in the re module examples. (GH-4616) (#4617)Miss Islington (bot)2017-11-281-4/+4
| | | (cherry picked from commit c615be5166ed338c052fa67fe781b9bfe0dfb78c)
* bpo-32051: Fix name shadowing in multiprocessing docs (GH-4469)Miss Islington (bot)2017-11-271-2/+2
| | | (cherry picked from commit c172fc5031a4035986bef0b2fcef906706d7abf3)