Commit Graph

21458 Commits

Author SHA1 Message Date
Miss Islington (bot) ca2fa2841f
closes bpo-28955: Clarified comparisons between NaN and number in reference documentation (GH-5982)
Co-authored-by: Benjamin Peterson <benjamin@python.org>
(cherry picked from commit ad8a000420)

Co-authored-by: Tony Flury <anthony.flury@btinternet.com>
2018-09-14 11:05:38 -07:00
Miss Islington (bot) a8f189f457 Note that distinct argument patterns can be cached separately (GH-9298) (GH-9299)
(cherry picked from commit 902bcd9a1e)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2018-09-14 01:13:17 -07:00
Miss Islington (bot) 305056494d
bpo-34247: add porting note to 3.7 What's New (GH-9223)
(cherry picked from commit 66755cbb1e)

Co-authored-by: Ned Deily <nad@python.org>
2018-09-13 12:14:46 -07:00
Miss Islington (bot) b608fcd444
closes bpo-34004: Skip lock interruption tests on musl. (GH-9224)
Returning EINTR from pthread semaphore or lock acquisition is an optional POSIX
feature. musl does not provide this feature, so some threadsignal tests fail
when Python is built against it.

There's no good way to test for musl, so we skip if we're on Linux and not using
glibc pthreads.

Also, hedge in the threading documentation about when we can provide interrupts
from lock acquisition.
(cherry picked from commit 5b10d5111d)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2018-09-12 14:10:56 -07:00
Benjamin Peterson cadb66e173
[3.7] closes bpo-25041: Document AF_PACKET socket address format. (GH-9207)
(cherry picked from commit 731ff68eee)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-09-11 18:46:36 -07:00
Miss Islington (bot) e2b40f4ce9
bpo-34365: Update date object documentation (GH-8814)
Python 3.x does not fall back to comparing object addresses when comparing two `dt` objects.

<!-- issue-number: [bpo-34365](https://www.bugs.python.org/issue34365) -->
https://bugs.python.org/issue34365
<!-- /issue-number -->
(cherry picked from commit 9c223794c7)

Co-authored-by: Danish Prakash <grafitykoncept@gmail.com>
2018-09-11 14:24:53 -07:00
Miss Islington (bot) e02ca4270e
bpo-34613: document the correct value of limit argument of asyncio.StreamReader (GH-9121)
The default value of asyncio.StreamReader *limit* is `_DEFAULT_LIMIT` instead of `None`.

<!-- issue-number: [bpo-34613](https://www.bugs.python.org/issue34613) -->
https://bugs.python.org/issue34613
<!-- /issue-number -->
(cherry picked from commit b4ec36200a)

Co-authored-by: Bram <cortex@worlddomination.be>
2018-09-11 11:59:29 -07:00
Miss Islington (bot) 3e648f8371
bpo-28617 Fixed docs inaccuracies about the types that support membership tests (GH-9086)
<!-- issue-number: [bpo-28617](https://www.bugs.python.org/issue28617) -->
https://bugs.python.org/issue28617
<!-- /issue-number -->
(cherry picked from commit 08bcf647d8)

Co-authored-by: wim glenn <wim.glenn@gmail.com>
2018-09-11 11:13:33 -07:00
Miss Islington (bot) c9ece5f4a9
closes bpo-33883: Mention type checkers in the FAQ. (GH-7760)
(cherry picked from commit a378254186)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-09-10 22:27:00 -07:00
Miss Islington (bot) 2110f78d92
bpo-33032: Mention the implicit cache in struct.Struct() docs (GH-7700)
Mention the implicit cache in struct.Struct() docs.

Consistent with the re.compile documentation note.
(cherry picked from commit 3666b3c1f6)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2018-09-10 21:50:41 -07:00
Miss Islington (bot) 6df2005b39 Fix missing line from example shell session (GH-9143) (GH-9155)
(cherry picked from commit 2064bb6d57)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2018-09-10 19:13:02 -07:00
Miss Islington (bot) 037582eb7f
bpo-33460: remove ellipsis that look like continuation prompts (GH-7851)
Remove ellipsis that look like continuation prompts,
has a side benefit of putting rest of error message in proper text color.
(cherry picked from commit f019579828)

Co-authored-by: Lew Kurtz <37632626+lew18@users.noreply.github.com>
2018-09-10 18:49:39 -07:00
Miss Islington (bot) f3d00ae3be
switch descriptor howto to return value annotation (GH-7796)
(cherry picked from commit 28ea4c2847)

Co-authored-by: NotAFile <notafile@gmail.com>
2018-09-10 17:44:58 -07:00
Miss Islington (bot) 011141f312
closes bpo-34525: Fix smtplib's authobject() documentation (GH-8965)
(cherry picked from commit 78deb7f332)

Co-authored-by: Sebastian Rittau <srittau@rittau.org>
2018-09-10 11:13:13 -07:00
Miss Islington (bot) 9c9ac9e697
Revert "Fix misindented yaml in logging how to example (GH-8604)" (GH-9081)
This reverts commit 10b59f1b01.
(cherry picked from commit 290a60bd8a)

Co-authored-by: Rémy HUBSCHER <hubscher.remy@gmail.com>
2018-09-10 02:13:18 -07:00
Miss Islington (bot) 9835696ec4
bpo-34246: Use no mutable default args in smtplib (GH-8554)
Some methods of the SMTP class use mutable default arguments. Specially
`send_message` is affected as it mutates one of the args by appending items
to it, which has side effects on further calls.
(cherry picked from commit d5fbe9b1a3)

Co-authored-by: Pablo Aguiar <scorphus@gmail.com>
2018-09-07 15:29:27 -07:00
Miss Islington (bot) 854b740910 Doc: Missing 'f' in an f-string. (GH-9074) (GH-9095)
(cherry picked from commit 25fa141487)

Co-authored-by: Julien Palard <julien@palard.fr>
2018-09-07 11:59:00 +02:00
Miss Islington (bot) f4c865eda8
Fix struct sequence glossary entry grammar (GH-9030)
... by removing a superfluous "either".

Reported by Никита Люшненко on docs@.
(cherry picked from commit 98b976a2f8)

Co-authored-by: Zachary Ware <zachary.ware@gmail.com>
2018-09-01 22:13:34 -04:00
Miss Islington (bot) fa3fd4cb18
bpo-34434: Update doc for bool(), float() and int() arguments (GH-8834)
(cherry picked from commit 3fe89dac42)

Co-authored-by: Louis Sautier <sautier.louis@gmail.com>
2018-08-27 06:58:56 -04:00
Miss Islington (bot) 42a1ca65d0
closes bpo-34502: Remove a note about utf8_mode from sys.exit() docs. (GH-8928)
(cherry picked from commit 44838be9f7)

Co-authored-by: Alexey Izbyshev <izbyshev@ispras.ru>
2018-08-25 14:36:18 -04:00
Miss Islington (bot) 6dc8f05437
Fix markup in stdtypes documentation (GH-8905)
(cherry picked from commit 2e5d2ea208)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-08-25 10:22:00 -04:00
Miss Islington (bot) 1f9621cb9b
Fixed typo with asynccontextmanager code example (GH-8845)
`yield conn`, instead of just `yield`.
(cherry picked from commit 416cbce22d)

Co-authored-by: Alexander Vasin <hi@alvass.in>
2018-08-24 22:51:10 -04:00
Miss Islington (bot) 7b0ed43af5 bpo-33550: Warn not to set SIGPIPE to SIG_DFL (GH-6773)
(cherry picked from commit a2510732da)

Co-authored-by: Alfred Perlstein <alfred@freebsd.org>
2018-08-24 19:28:58 -07:00
Miss Islington (bot) a8c749df59 Fix typo in the dataclasses's doc (GH-8896) (GH-8897)
(cherry picked from commit 075b3c3259)

Co-authored-by: Daniel Dương <dduong42@users.noreply.github.com>
2018-08-24 05:37:19 -04:00
Miss Islington (bot) 1d3d688b98
Fix doc for `add_subparsers` arguments (GH-8884)
There was a missing comma.
(cherry picked from commit cc18258daf)

Co-authored-by: Anthony Sottile <asottile@umich.edu>
2018-08-23 23:22:17 -04:00
Miss Islington (bot) 609c033f43
Fix typo in asyncio.BoundedSemaphore docs (GH-8882)
semapthores -> semaphores
(cherry picked from commit b8a181f4ae)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2018-08-23 22:03:23 -04:00
Miss Islington (bot) 1f7d0470c2
Make it more clear that setUpClass runs before each class, not "class run" (GH-8844)
(cherry picked from commit c33bb5d401)

Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
2018-08-23 11:02:46 -04:00
Miss Islington (bot) 0e1e8dbb0b
bpo-22057: Clarify eval() documentation (GH-8812)
If a globals dictionary without a '__builtins__' key is passed to
eval(), a '__builtins__' key will be inserted to the dictionary:

    >>> eval("print('__builtins__' in globals())", {})
    True

(As a result of this behavior, we can use the builtins
print() and globals() even if we passed a dictionary without a
'__builtins__' key to eval().)
(cherry picked from commit 225b055480)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
2018-08-19 06:29:50 -04:00
Miss Islington (bot) 0fd6f832a9 bpo-34432: doc Mention complex and decimal.Decimal on str.format note about locales (GH-8808) (GH-8809)
(cherry picked from commit 93b5655c04)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-08-18 14:16:36 -04:00
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) 393151e241
Fix misindented yaml in logging how to example (GH-8604)
(cherry picked from commit 10b59f1b01)

Co-authored-by: Rémy HUBSCHER <hubscher.remy@gmail.com>
2018-08-12 17:04:44 -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) 426135b674
Improve grammar of asynchronous iterator glossary entry (GH-8657)
(cherry picked from commit cf2c5e8e28)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-08-09 09:08:49 -07:00
Miss Islington (bot) fe8f90aa3c
bpo-34324: Doc README wrong directory name for venv (GH-8650)
In the documentation, the `env` directory is specified when we execute
the `make venv` command. But in the code, `make venv` will create the
virtualenv inside the `venv` directory (defined by `VENVDIR`)
(cherry picked from commit 599bfa18f8)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-08-09 08:10:27 -07:00
Miss Islington (bot) 292030354a
Make code examples in Functional Programming HOWTO to be PEP 8 compliant. (GH-8646)
(cherry picked from commit db8707c8ab)

Co-authored-by: Sergey Fedoseev <fedoseev.sergey@gmail.com>
2018-08-07 14:56:25 -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) b481aeeff7
Fix HTML formatting in datamodel.rst (GH-8693)
(cherry picked from commit 3c1b590472)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
2018-08-06 14:12:37 -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) 34f59a7a78
bpo-34317: Fix a dead url to Windows documentation (GH-8622)
(cherry picked from commit 46ebe61c7f)

Co-authored-by: HiyashiChuka <41299525+hiyashichuka@users.noreply.github.com>
2018-08-02 20:29:39 -07:00
Miss Islington (bot) 66ff9d270c
Update list.remove(x) documentation (GH-8636)
Rephrase it to "It raises a `ValueError`"
(cherry picked from commit bcd1d971b6)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2018-08-02 20:03:19 -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