Commit Graph

20542 Commits

Author SHA1 Message Date
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) de8567e38c
bpo-26701: Improve documentation for the rounding special methods. (GH-6054)
(cherry picked from commit 496431ffb6)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-03-10 07:55:13 -08: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) 3f7d0b69f2
controlflow: Use full example for "5 through 9" (GH-5907)
Replace example result of "5 through 9" with complete list: "5, 6, 7, 8, 9".
This format is more consistent with the surrounding examples.
(cherry picked from commit 83d7062d2d)

Co-authored-by: Steven M. Vascellaro <S.Vascellaro@gmail.com>
2018-03-09 12:11:30 -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
Miss Islington (bot) 5a07608d08
bpo-31454: Include information about "import X as Y" in Modules tutorial (GH-4041)
(cherry picked from commit fbee88244e)

Co-authored-by: Mario Corchero <mariocj89@gmail.com>
2018-02-25 11:33:14 -08:00
Miss Islington (bot) b9678d3aa1
bpo-25059: Clarify the print separator usage in tutorial (GH-5879)
By default `print` adds spaces between its arguments.
(cherry picked from commit 84c4b0cc67)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-02-25 11:21:15 -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) fc9471a888
bpo-17232: Clarify docs for -O and -OO command line options (GH-5839)
The 'optimization' is for space in the executable file, not for run time.
(cherry picked from commit 186b606d8a)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-02-24 19:46:16 -08: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) dd52d5c868
bpo-32087: Doc: Make "deprecated-removed" directive translatable (GH-4473)
(cherry picked from commit 0febc05373)

Co-authored-by: cocoatomo <cocoatomo77@gmail.com>
2018-02-23 04:14:04 -08:00
Miss Islington (bot) 6eab93cfe5 bpo-30449: Improve __slots__ documentation (GH-1819)
(cherry picked from commit 2b44e302ec)


Co-authored-by: Aaron Hall, MBA <aaronchall@yahoo.com>
2018-02-22 09:37:40 -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) 76c3f5eeb0 bpo-32540: Update venv documentation (GH-5736)
If the directory already exists, it will be re-used.
(cherry picked from commit e8eb972514)


Co-authored-by: TROUVERIE Joachim <joachim.trouverie@linoame.fr>
2018-02-20 20:26:21 -08:00
Miss Islington (bot) 6ae87cae09
bpo-32500: Correct the documentation for PySequence_Size() and PySequence_Length() (GH-5767)
Dropped the part that says: "For objects that do not provide sequence protocol".
(cherry picked from commit 7a1e1786f9)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2018-02-20 11:46:06 -08: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) 1b9bbbcad3
Fix installation instructions for *nix (GH-5605)
Remove pkg_add -r python from FreeBSD installation section.
Moved to OpenBSD.
(cherry picked from commit 3384d38d51)

Co-authored-by: Eitan Adler <grimreaper@users.noreply.github.com>
2018-02-13 20:00:38 -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
Serhiy Storchaka 3d4a174c0e
[3.6] Make formatting of some return codes conforming to the general style. (GH-5587). (GH-5598)
(cherry picked from commit 5bb0005f9f)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-02-09 14:48:31 +02: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) a8c25d1c7f [3.6] bpo-8722: Document __getattr__ behavior with AttributeError in property (GH-5542)
When `__getattr__` is implemented, attribute lookup will always fall back to that,
even if the initial failure comes from `__getattribute__` or a descriptor's `__get__`
method (including property methods).
(cherry picked from commit d1f318105b)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-02-05 13:10:00 +10: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
Ned Deily 0cb82eb7e5 Update Doc build for split off of 3.7 branch 2018-02-03 16:28:44 -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) 581ce25e1f bpo-32735: Fix typo in f-strings datetime format specifier example (GH-5464) (GH-5465)
The f-string example for using datetime format specifier does not match the given output.
Changed the format from %b to %B so it matches the output of "January".
(cherry picked from commit b299393cc3)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-01-31 17:17:02 -05: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) 5869861823 Document the error return of PyLong_As* APIs. (GH-5396) (#5404)
Document the error return of PyLong_As* APIs.

A frequent Python C API usage error is neglecting to check the return
value and/or PyErr_Occurred().
(cherry picked from commit f5b04a360e)
2018-01-29 09:24:11 -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) 33febfb039 Fix PyTrace_RETURN documentation (GH-5384) (GH-5386)
It will be triggered when propagating an exception.
(cherry picked from commit 79db11ce99)
2018-01-28 23:33:23 +08:00
Miss Islington (bot) 854f0424de bpo-32687: Fix wrong meaning of args for PyTrace_LINE/CALL in documentation (GH-5361) (GH-5377)
(cherry picked from commit 9ed0aee27c)
2018-01-28 16:41:05 +08:00
Miss Islington (bot) 0135dfdc1f Minor grammar fixes to License.rst (GH-1174) (GH-5373)
(cherry picked from commit 8312fba0a1)
2018-01-27 21:06:12 -08:00
Miss Islington (bot) d331515847 [3.6] bpo-32664: Add missing "|" connector in Exceptions doc (GH-1173) (GH-5372)
(cherry picked from commit 992ae6444c)
2018-01-27 19:52:52 -08:00
Cheryl Sabella 8f68cb7db3 [3.6] bpo-27505: Retrofit module __class__ documentation from 3.7 (GH-5321)
The module `__class__` attribute documentation added to 3.7 for PEP 562
(dynamic module attributes) also applies to earlier versions. This backports
that subset of the new docs to the 3.6 branch so that it will appear in the
main online documentation and in the final 3.6 binary release.

Patch by Cheryl Sabella.
2018-01-27 12:45:24 +10:00
Bo Bayles 995c60d265 [3.6] bpo-32304: Fix distutils upload for tar files ending with b'\r' (GH-5264) (GH-5330)
Patch by Bo Bayles.
2018-01-26 21:18:58 -05:00