Commit graph

9040 commits

Author SHA1 Message Date
Miss Islington (bot)
05d89ef785
bpo-34418: Fix HTTPErrorProcessor documentation (GH-8793)
The http_response() and https_response() methods of the HTTPErrorProcessor
class have two required parameters, 'request' and 'response'.
(cherry picked from commit c53aaec793)

Co-authored-by: Sebastian Rittau <srittau@rittau.org>
2018-08-17 06:02:08 -04:00
Miss Islington (bot)
6c14060977
smtplib documentation fixes (GH-8708)
* SMTP.startssl: Fix doc on keyfile and certfile use

* SMTP.startssl: Add missing keyfile and certfile deprecation notice

* SMTP: Doc grammar fixes
(cherry picked from commit da12063f2f)

Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
2018-08-12 21:06:22 -07:00
Miss Islington (bot)
7e0153e166
Fix the versionadded indentation in exec_module doc (GH-8719)
(cherry picked from commit 65b5ef02ec)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-08-12 00:01:21 -07:00
Miss Islington (bot)
6b14508522
bpo-34379: Doc: Move note for json.dump (GH-8730)
(cherry picked from commit 9e84084851)

Co-authored-by: Evan Allrich <eallrich@gmail.com>
2018-08-11 01:02:03 -07:00
Miss Islington (bot)
56410810d3
Doc: add missing capture_output arg to subprocess.run() signature (GH-8374)
(cherry picked from commit 22d131a7f9)

Co-authored-by: Andriy Maletsky <9919211+and800@users.noreply.github.com>
2018-08-09 15:03:52 -07:00
Miss Islington (bot)
fac49762c5
bpo-34335: Use async/await syntax in documentation examples (GH-8674)
(cherry picked from commit d2ac400267)

Co-authored-by: Mikhail Terekhov <termim@gmail.com>
2018-08-07 13:33:31 -07:00
Miss Islington (bot)
1c6df83e93
bpo-34319: Clarify file handler closure in pathlib.read_text (GH-8645)
Patch by Terry Jan Reedy.
(cherry picked from commit 5b2657fb8c)

Co-authored-by: Xtreak <tirkarthi@users.noreply.github.com>
2018-08-06 12:59:43 -07:00
Miss Islington (bot)
e39fb207f2
bpo-34273: Change 'Fixed point' to 'Fixed-point notation'. (GH-8673)
* bpo-34273: Change 'Fixed point' to 'Fixed-point notation'.
The change in the mini language floating point and decimal table
is consistent with 'Exponential notation' and clarifies that we
are referring to the output notation, not an object type.

* Update string.rst

* Update string.rst

* Update string.rst

* Update string.rst
(cherry picked from commit 28c7f8c8ce)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-08-06 05:47:36 -07:00
Miss Islington (bot)
e610c4f998
bpo-34336: Don't promote possibility to leave out typing.Optional (GH-8677)
(cherry picked from commit 336c945858)

Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
2018-08-05 10:36:04 -07:00
Miss Islington (bot)
2a2a3f56f5 Fix reST markup in unittest documentation (GH-8665)
(cherry picked from commit 2e5566d9e7)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
2018-08-04 01:13:52 +03:00
Miss Islington (bot)
39fcd99498 bpo-34329: Doc'd how to remove suffix of pathlib.Path() (GH-8655)
(cherry picked from commit 46dc4e34ed)

Co-authored-by: Stefan Otte <stefan.otte@gmail.com>
2018-08-04 00:45:46 +03:00
Miss Islington (bot)
b4d71c9149
Improve the grammar in range documentation. (GH-8628)
Remove unnecessary "that" in the sentence.
(cherry picked from commit b6efc2cf97)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-08-02 23:16:07 -07:00
Miss Islington (bot)
0f9df886d6 bpo-27910: Update documentation of traceback module (GH-6116)
In the documentation for the traceback module, the definitions of functions
extract_tb(), format_list() and classmethod StackSummary.from_list()
mention the old style 4-tuples that these functions used to return or accept.

Since Python 3.5, however, they return or accept a FrameSummary object
instead of a 4-tuple, or a StackSummary object instead of a list of 4-tuples.

Co-authored-by: torsava <torsava@redhat.com>
Co-Authored-By: Berker Peksag <berker.peksag@gmail.com>

(cherry picked from commit f394ee5eaf)
2018-08-02 19:51:48 +03:00
Serhiy Storchaka
47957dab94
[3.7] bpo-33729: Fix issues with arguments parsing in hashlib. (GH-8346) (GH-8581)
* help(hashlib) didn't work because of incorrect module name in blake2b and
  blake2s classes.
* Constructors blake2*(), sha3_*(), shake_*() and keccak_*() incorrectly
  accepted keyword argument "string" for binary data, but documented as
  accepting the "data" keyword argument. Now this parameter is positional-only.
* Keyword-only parameters in blake2b() and blake2s() were not documented as
  keyword-only.
* Default value for some parameters of blake2b() and blake2s() was None,
  which is not acceptable value.
* The length argument for shake_*.digest() was wrapped out to 32 bits.
* The argument for shake_128.digest() and shake_128.hexdigest() was not
  positional-only as intended.
* TypeError messages for incorrect arguments in all constructors sha3_*(),
  shake_*() and keccak_*() incorrectly referred to sha3_224.

Also made the following enhancements:

* More accurately specified input and result types for strings, bytes and
  bytes-like objects.
* Unified positional parameter names for update() and constructors.
* Improved formatting.
(cherry picked from commit f1d36d8efa)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-07-31 10:22:44 +03:00
Steve Dower
3dc8cdf56d
bpo-8145: Improve isolation_level documentation (GH-8499)
Initial patch by R. David Murray.
2018-07-29 12:06:35 +01:00
Miss Islington (bot)
8764a6ffda
bpo-29710: Clarify documentation for Bitwise binary operation (GH-1691)
Mathematically, bitwise operations on integers behave as if there were an
infinite number of sign bits. Pragmatically, that gives the same answer as
using one extra sign bit for the bitwise logical operations.
(cherry picked from commit b4bc5cab82)

Co-authored-by: Sanyam Khurana <8039608+CuriousLearner@users.noreply.github.com>
2018-07-28 09:52:14 -07:00
Steve Dower
83b449d754
bpo-24356: Specify which Python binary will be used with venv (GH-6589) 2018-07-28 17:48:29 +01:00
Miss Islington (bot)
2335544562
bpo-33921: Clarify how to bind to all interfaces using socket (GH-7877)
Clarify how to bind to all interfaces using socket
(cherry picked from commit 95dfb9c3ae)

Co-authored-by: johnthagen <johnthagen@users.noreply.github.com>
2018-07-28 05:27:15 -07:00
Miss Islington (bot)
c6801b48a1
bpo-5978: Document that profiling needs cmd/function to return (GH-7938)
<!-- issue-number: bpo-5978 -->
https://bugs.python.org/issue5978
<!-- /issue-number -->
(cherry picked from commit 937fb55d35)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-28 05:23:42 -07:00
Miss Islington (bot)
6f7fd963a0 Fix site module documentation. (GH-8441)
The script will exit with the number 0 (zero), instead of the letter O.
(cherry picked from commit 95d34c2a37)

Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
2018-07-24 10:30:33 -07:00
Miss Islington (bot)
4e166ffd29 bpo-33468: Add try-finally contextlib.contextmanager example (GH-7816) (GH-8425)
(cherry picked from commit bde782bb59)

Co-authored-by: Matthias Bussonnier <bussonniermatthias@gmail.com>
2018-07-24 00:38:18 +03:00
Miss Islington (bot)
05a72f15f7 bpo-21446: Update reload fixer to use importlib (GH-8391)
(cherry picked from commit 7a3056fa7d)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
2018-07-23 11:11:22 +03:00
Miss Islington (bot)
7cf7541aa4 Fix versionchanged indentation in popitem documentation (GH-8387)
(cherry picked from commit cb9c299a55)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-21 16:04:54 -07:00
Miss Islington (bot)
68833dcbd4 Clarify ValueError's broad applicability (GH-8313) (GH-8315)
(cherry picked from commit feabae9617)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2018-07-17 13:22:50 -07:00
Miss Islington (bot)
bfa8a358e2 bpo-34123: Fix missed documentation update for dict.popitem(). (GH-8292) (GH#8307) 2018-07-16 19:08:13 -07:00
Miss Islington (bot)
43c2fabb2f bpo-34124: Fix markup of message_from_binary_file() signature (GH-8297)
(cherry picked from commit c9265c1534)

Co-authored-by: Jon Ribbens <jribbens@gmail.com>
2018-07-16 21:43:41 +03:00
Miss Islington (bot)
08c1da7103
bpo-4260: Document that ctypes.xFUNCTYPE are decorators (GH-7924)
(cherry picked from commit 379e9d639a)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-13 06:35:31 -07:00
Miss Islington (bot)
6b1b6e4385
Doc: Point to Simple statements section instead of PEP (GH-8238)
(cherry picked from commit 33aefad342)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-11 03:32:31 -07:00
Miss Islington (bot)
bcea15a611 Dataclasses: Fix example on 30.6.8, add method should receive a list rather than an integer. (GH-8038) (GH-8237)
Change example function to append rather than add lists.
(cherry picked from commit da5e9476bb)

Co-authored-by: Tom Faulkner <tomfaulkner@gmail.com>
2018-07-11 06:11:11 -04:00
Miss Islington (bot)
1b6e217304
bpo-34067: Include a more easily understood example for nullcontext (GH-8158)
Include a more easily understood example for nullcontext
(cherry picked from commit c287545d62)

Co-authored-by: Daniel Porteous <danielporteous1@gmail.com>
2018-07-09 07:11:42 -07:00
Serhiy Storchaka
7c43b80150
[3.7] bpo-26544: Fixed implementation of platform.libc_ver(). (GH-7684). (GH-8193)
(cherry picked from commit 2a9b8babf0)
2018-07-09 12:55:35 +03:00
Miss Islington (bot)
79c6b35b35
Fix margin in sentinel and mock_open (GH-8188)
(cherry picked from commit f85af035c5)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-08 17:48:02 -07:00
Marcin Niemira
0b63759651 bpo-34061: Document sqlite3.NotSupportedError (GH-8172)
(cherry picked from commit bc9aa813a3)

Co-authored-by: Marcin Niemira <marcin@niemira.net>
2018-07-08 16:59:48 +03:00
Miss Islington (bot)
a912305512
closes bpo-34050: Fix link in SSL docs (GH-8173)
(cherry picked from commit 9c5ba09748)

Co-authored-by: Marcin Niemira <marcin@niemira.net>
2018-07-07 15:47:35 -07:00
Miss Islington (bot)
e5b47ea585
bpo-33804: Document that the argument for io.TextIOBase.read() is optional (GH-7510)
(cherry picked from commit b6bb77c2b8)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-07 13:39:03 -07:00
Miss Islington (bot)
c5e4c76eaa
Fix moduleauthor/sectionauthor directives in Enum (GH-8117)
(cherry picked from commit 2d748389dc)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-07 12:32:08 -07:00
Miss Islington (bot)
c8b18d3192
Add missing closing parentheses (GH-8144)
(cherry picked from commit 03dd0e794e)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-07 12:19:55 -07:00
Dong-hee Na
75f2eb5eca [3.7] bpo-34065: Improve the markup of logging.basicConfig() arguments (GH-8153). (GH-8156)
(cherry picked from commit 2800dcf656)

Co-authored-by: Dong-hee Na <donghee.na92@gmail.com>
2018-07-07 19:12:11 +03:00
Miss Islington (bot)
e217d23886
Doc: Remove superfluous markup. (GH-8112)
The line is speaking of a list of commands, not the list command.
(cherry picked from commit 7943c5e8b5)

Co-authored-by: Julien Palard <julien@palard.fr>
2018-07-06 02:34:24 -07:00
Miss Islington (bot)
a8bb18bbb9 bpo-30516: Fix documentation issue with -timedelta in datetime (GH-7348) (GH-8093)
This commit fixes the -timedelta overfllow issue not documented properly.

Signed-off-by: Farhaan Bukhsh <farhaan.bukhsh@gmail.com>
(cherry picked from commit 5b6e49a139)

Co-authored-by: Farhaan Bukhsh <farhaan.bukhsh@gmail.com>
2018-07-05 00:04:24 +01:00
Miss Islington (bot)
6699386231 bpo-34018: Doc'd that type names of SQLite converters are case-insensitive. (GH-8042) (GH-8065)
(cherry picked from commit 831c29721d)

Co-authored-by: Sergey Fedoseev <fedoseev.sergey@gmail.com>
2018-07-03 15:37:16 +03:00
Chris Cogdon
24d74bd837 bpo-33961: Adjusted dataclasses docs to correct exceptions raised. (GH-7917) 2018-07-02 06:21:50 -04:00
Miss Islington (bot)
f9ae07441c Doc: Remove unused image file (GH-8027)
(cherry picked from commit fe524df37c)
2018-07-01 03:30:43 +09:00
Miss Islington (bot)
fd1c092bb9 bpo-32568: make select.epoll() and its docs consistent (GH-7840) (GH-8024)
* `flags` is indeed deprecated, but there is a validation on its value for
  backwards compatibility reasons.  This adds mention of this in the docs.
* The docs say that `sizehint` is deprecated and ignored, but it is still
  used when `epoll_create1()` is unavailable. This adds mention of this in
  the docs.
* `sizehint=-1` is acceptable again, and is replaced with `FD_SETSIZE-1`.
  This is needed to have a default value available at the Python level,
  since `FD_SETSIZE` is not exposed to Python. (see: bpo-31938)
* Reject `sizehint=0` since it is invalid to pass on to `epoll_create()`.

The relevant tests have also been updated.

(cherry picked from commit 0cdf5f4289)

Co-authored-by: Tal Einat <taleinat+github@gmail.com>
2018-06-30 16:03:19 +03:00
Miss Islington (bot)
d0b442803a
Fix the indentation in the documentation of bin() and hash() (GH-7998)
(cherry picked from commit bda9c3eae3)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-06-29 03:16:26 -07:00
Miss Islington (bot)
4c20d2bf5d
bpo-33985: Implement ContextVar.name attribute. (GH-7980)
(cherry picked from commit 41cb0baea9)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-06-28 10:39:54 -07:00
Miss Islington (bot)
150cd3cb27 [3.7] bpo-33573: docs to suggest median() alternatives for non-numeric data (GH-7587) (GH-7906)
(cherry picked from commit fdd6e0bf18)
2018-06-25 14:18:54 +03:00
Miss Islington (bot)
80f1a908a8 bpo-33952: Fix typo in str.upper() documentation (GH-7898) (GH-7903)
(cherry picked from commit 4a6e746079)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-06-25 13:42:20 +03:00
Miss Islington (bot)
66d77d8af8 bpo-33943: Add references in the docs for logging.basicConfig (GH-7858) (GH-7900)
Adds references to info about file modes, `time.strftime()`, string formatting
syntaxes, and logging levels.

(cherry picked from commit a8ddf85a84)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-06-25 09:25:58 +03:00
Miss Islington (bot)
e4db73058b
bpo-33885: Replace "hook function" with "callable" (GH-7765)
(cherry picked from commit c45cb47907)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-06-22 14:30:45 -07:00