Commit graph

8511 commits

Author SHA1 Message Date
Julien Palard
66b3f53db9
[3.6] Fix typos '.::' should typically just be '::'. (GH-6165). (GH-6895)
(cherry picked from commit 78553138be)
2018-05-19 09:28:28 +02:00
Miss Islington (bot)
a5f33a899f bpo-19950: Clarify unittest TestCase instance use. (GH-6875) (GH-6939)
(cherry picked from commit dff46758f2)

Co-authored-by: Gregory P. Smith <greg@krypto.org> Google
2018-05-18 17:55:05 -07:00
Stéphane Wirtel
e4cd12d3d3 [3.6] bpo-33503: Fix the broken pypi link in the source and the documentation (GH-6814) (GH-6885)
(cherry picked from commit 19177fbd5d)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-05-16 10:08:23 -04:00
Petr Viktorin
e618e96581
bpo-28167: bump platform.linux_distribution removal to 3.8 (GH-6864)
This is a backport of the documentation part of GH-6862

Co-authored-by: Matthias Bussonnier <bussonniermatthias@gmail.com>
2018-05-15 13:31:47 -04:00
Travis DePrato
295465dc29 Add AsyncContextManager to typing module documentation. (GH-6823) 2018-05-14 22:07:21 -04:00
Miss Islington (bot)
914bad6e2c
Add versionchanged in create_datagram_endpoint doc (GH-4697)
Most of the parameters were added in 3.4.4 (b9bf913ab3), but this
change was not documented
(cherry picked from commit 0ded580403)

Co-authored-by: Romuald Brunet <romuald@chivil.com>
2018-05-14 13:12:47 -07:00
Miss Islington (bot)
9fd5b5fdf8
bpo-22069: Update TextIO documentation (GH-6609)
Clarify that flush is implied when the call to write contains a newline character.
(cherry picked from commit 7ffd4c58fa)

Co-authored-by: Elena Oat <oat.elena@gmail.com>
2018-05-14 09:18:07 -07:00
Miss Islington (bot)
7488c79b60
bpo-26701: Tweak the documentation for special methods in int(). (GH-6741)
(cherry picked from commit df00f04825)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-05-10 07:38:20 -07:00
Miss Islington (bot)
6079b607d3
Fix superfluous if in documentation. (GH-6728)
(cherry picked from commit b3c369861b)

Co-authored-by: Julien Palard <julien@palard.fr>
2018-05-09 01:10:12 -07:00
Miss Islington (bot)
eb5abdc708 bpo-33400: Clarified documentation to indicate no strict adherence to ISO 8601. (GH-6703)
(cherry picked from commit c4994dc00d)

Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2018-05-04 23:02:48 +01:00
Miss Islington (bot)
9a039d5679
bpo-32362: Fix references to non-existent multiprocessing.Connection() (GH-6223)
(cherry picked from commit 9f3535c9cd)

Co-authored-by: Bo Bayles <bbayles@gmail.com>
2018-04-29 12:11:01 -07:00
Andrés Delfino
4533494ac5 [3.6] bpo-33280: Reorganize external Tcl/Tk references. (GH-6473). (#6602)
(cherry picked from commit 67a8f4fed3)

Co-authored-by: Andrés Delfino <34587441+andresdelfino@users.noreply.github.com>
2018-04-26 17:10:10 +03:00
Miss Islington (bot)
5c0a8bb1c2
bpo-33297: Mention Pillow to work with more image formats. (GH-6505)
Also update PIL doc references to Pillow.
(cherry picked from commit b81ca28b37)

Co-authored-by: Andrés Delfino <34587441+andresdelfino@users.noreply.github.com>
2018-04-21 06:04:08 -07:00
Terry Jan Reedy
82de43fdd5
[3.6] Spelling fixes to docs, docstrings, and comments (GH-6374) (#6558)
(cherry picked from commit 61f82e0e33)
2018-04-20 20:49:07 -04:00
Miss Islington (bot)
f44ce356a6
bpo-33283: Mention PNG as a supported format by Tcl/Tk. (GH-6479)
(cherry picked from commit 4b685bf719)

Co-authored-by: Andrés Delfino <34587441+andresdelfino@users.noreply.github.com>
2018-04-17 03:10:39 -07:00
Miss Islington (bot)
c0a0c64fe2 Revert 725476222a (GH-6494) (GH-6496)
This note in documentation was never true.
(cherry picked from commit a00d440edb)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2018-04-16 20:35:13 -07:00
Miss Islington (bot)
e98e3385f2
Fix error messages in argparse examples (GH-6435)
The examples in argparse documentation use `error: too few arguments`
error message which was removed in this commit f97c59a in 2011.
(cherry picked from commit 04e8293465)

Co-authored-by: suic86 <marko.gabriel.cz@gmail.com>
2018-04-11 12:05:52 -07:00
Serhiy Storchaka
1429ac9f2c
[3.6] Improve highlighting of some code blocks. (GH-6401). (GH-6424)
(cherry picked from commit 46936d5a71)
2018-04-09 17:57:07 +03:00
Miss Islington (bot)
280a767d02 Add a prepend() recipe to teach a chain() idiom (GH-6415) (GH-6422)
(cherry picked from commit 9265dd72e5)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2018-04-08 14:37:47 -07:00
Miss Islington (bot)
70c4446547 [3.6] bpo-8243: Doc patch for curses.window.addstr and curses.window.addch (GH-5179) (GH-6406)
(cherry picked from commit ef5ce884a4)

Co-authored-by: Jay Crotts <crotts.jay@gmail.com>
2018-04-06 22:01:03 -04:00
Miss Islington (bot)
fa5157e049
closes bpo-33202: fix os.walk mentioning os.listdir instead of os.scandir (GH-6335)
(cherry picked from commit badb894bbb)

Co-authored-by: Andrés Delfino <34587441+andresdelfino@users.noreply.github.com>
2018-04-02 20:39:14 -07:00
Miss Islington (bot)
ddc99713d9
Fix socket type in DatagramHandler documentation: TCP -> UDP (GH-6272)
(cherry picked from commit 233de021d9)

Co-authored-by: Mike DePalatis <mike@depalatis.net>
2018-03-30 00:53:35 -07:00
Miss Islington (bot)
c8698cff7c bpo-27212: Modify islice recipe to consume initial values preceding start (GH-6195) (GH-6267)
(cherry picked from commit da1734c58d)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-03-26 19:24:02 -07:00
Miss Islington (bot)
643a781188
bpo-27428: Fix WindowsRegistryFinder documentation to list appropriate ABC (GH-6061)
(cherry picked from commit 5cbb84106e)

Co-authored-by: Himanshu Lakhara <himanshulakhara1947@gmail.com>
2018-03-23 14:50:09 -07:00
Miss Islington (bot)
fce39ab1c8 Fix a reference to the MRE book in re docs (GH-1113)
Reported by Maksym Nikulyak on docs.p.o.
(cherry picked from commit a0a42d22d8)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
2018-03-23 18:55:46 +03:00
Miss Islington (bot)
ae2feb32e7
bpo-27683: Fix a regression for host() of ipaddress network objects (GH-6016)
The result of host() was not empty when the network is constructed by a tuple containing an
integer mask and only 1 bit left for addresses.
(cherry picked from commit 10b134a07c)

Co-authored-by: Xiang Zhang <angwerzx@126.com>
2018-03-20 18:49:41 -07:00
Miss Islington (bot)
481cbe8d62
bpo-18802: Add more details to ipaddress documentation (GH-6083)
Original patch by Jon Foster and Berker Peksag.
(cherry picked from commit 5609b78392)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-03-20 17:59:00 -07:00
Miss Islington (bot)
47a0e64ccf
bpo-28247: Document Windows executable creation in zipapp (GH-6158)
(cherry picked from commit 4be79f2946)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-03-20 15:52:41 -07:00
Miss Islington (bot)
3f439d14ad bpo-33045: Fix typos in SSL documentation (GH-6065)
(cherry picked from commit 9cf8c42f32)

Co-authored-by: Matt Eaton <agnosticdev@gmail.com>
2018-03-11 04:26:01 +03:00
Miss Islington (bot)
1028ca4f04 bpo-26701: Add documentation for __trunc__ (GH-6050)
`int` fails back to `__trunc__` is `__int__` isn't defined, so cover
that in the docs.
(cherry picked from commit 308eab979d)

Co-authored-by: Eric Appelt <eric.appelt@gmail.com>
2018-03-11 01:10:45 +10:00
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