Commit Graph

10015 Commits

Author SHA1 Message Date
Miss Islington (bot) 12bb0b69ec
Update ssl.rst 2020-06-29 00:34:35 -07:00
Miss Islington (bot) ec05a7feed
bpo-40773: Fix rendering for 'retval' on the pdb page (GH-21081)
Automerge-Triggered-By: @merwok
(cherry picked from commit cf18c9e9d4)

Co-authored-by: Arisaka97 <solitaire2312@gmail.com>
2020-06-24 15:03:11 -07:00
Miss Islington (bot) 4f5dde463b
bpo-40707: Document that Popen.communicate sets the returncode attribute (GH-20283)
(cherry picked from commit bf2e515fa4)

Co-authored-by: Gareth Rees <gdr@garethrees.org>
2020-06-23 20:19:35 -07:00
Miss Islington (bot) 56d25add07
Improve asyncio.loop.call_soon() documentation (GH-20883)
* Add a glossary entry for the term "callback"
* Link to it in loop.call_soon() and in the "Concurrency and Multithreading" section

Co-authored-by: Kyle Stanley <aeros167@gmail.com>
(cherry picked from commit a16d697049)

Co-authored-by: Roger Iyengar <ri@rogeriyengar.com>
2020-06-22 19:23:49 -07:00
Miss Islington (bot) f8c05bb3a6
[3.8] bpo-37674: Tweak imp module deprecation note in the docs (GH-20480) (GH-20860)
(cherry picked from commit dea3223740)


Co-authored-by: Zackery Spytz <zspytz@gmail.com>

Automerge-Triggered-By: @brettcannon
2020-06-13 13:55:56 -07:00
Antoine Pitrou 972aba86ed
[3.8] bpo-40895: Update weakref documentation to remove old warnings (GH-20687) (GH-20792)
The doccumentation at https://docs.python.org/3.10/library/weakref.html cautions that the `WeakKeyDictionary` and `WeakValueDictionary` are susceptible to the problem of dictionary mutation during iteration.

These notes present the user with a problem that has no easy solution.

I dug into the implementation and found that fortunately, Antoine Pitrou already addressed this challenge (10 years ago!) by introducing an `_IterationGuard` context manager to the implementation, which delays mutation while an iteration is in progress.

I asked for confirmation and @pitrou agreed that these notes could be removed:
c1baa601e2GH-commitcomment-39514438.
(cherry picked from commit 1642c0ef75)

Co-authored-by: Daniel Fortunov <asqui@users.noreply.github.com>

Automerge-Triggered-By: @pitrou
2020-06-10 13:38:42 -07:00
Miss Islington (bot) 663836e117
[3.8] bpo-34003: Re-add versionchanged entry in csv docs (GH-20657) (GH-20771)
Follow-up to GH-8014
(cherry picked from commit 7aed0524d4)


Co-authored-by: Éric Araujo <merwok@netwok.org>

Automerge-Triggered-By: @merwok
2020-06-09 18:26:16 -07:00
Stefan Krah 32c1fb07e6
[3.8] Revert bpo-39576: docs: set context for decimal arbitrary precision arithmetic (GH-20745)
This reverts commit d6965ff026.
2020-06-09 01:33:08 +02:00
Stefan Krah 706de4e5a4
[3.8] Revert bpo-39576: Clarify the word size for the 32-bit build. (GH-20743)
This reverts commit c6ecd9c140.
2020-06-09 01:20:58 +02:00
Miss Islington (bot) 12dfbae2ec
bpo-22021: Update root_dir and base_dir documentation in shutil (GH-10367)
Also added an example in shutil in order to make more clear how they are to be used.

Initially reported by Weinan Li on bpo.
(cherry picked from commit 7633371dac)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2020-06-07 22:08:51 -07:00
Miss Islington (bot) c935b33322
Fix spacing in docs for tarfile (GH-20629)
Before
```
content.txt is 42 bytes in size and isa regular file.
folder is 420 bytes in size and isa directory.
magic is 4200 bytes in size and issomething else.
```

After:
```
content.txt is 42 bytes in size and is a regular file.
folder is 420 bytes in size and is a directory.
magic is 4200 bytes in size and is something else.
```

Automerge-Triggered-By: @orsenthil
(cherry picked from commit 7a280197f4)

Co-authored-by: Harsha Laxman <HarshaLaxman@users.noreply.github.com>
2020-06-04 13:19:47 -07:00
Miss Islington (bot) ef2f9acf8f
closes bpo-29017: Update the bindings for Qt information with PySide2 (GH-20149)
Reference to PySide has been removed has it is for Qt 4, which has reached end of life.
(cherry picked from commit 4649202ea7)

Co-authored-by: Samuel Gaist <samuel.gaist@idiap.ch>
2020-05-29 19:04:24 -07:00
Miss Islington (bot) f89d7bcdee
Note the output ordering of combinatoric functions (GH-19732) (GH-20502) 2020-05-28 13:33:57 -07:00
Miss Islington (bot) b5ecbf02e4
bpo-40025: Require _generate_next_value_ to be defined before members(GH-19763)
require `_generate_next_value_` to be defined before members
2020-05-27 13:12:08 -07:00
Tal Einat e3e800f3d2
[3.8] bpo-38580: Document that select() accepts iterables, not just sequences (GH-16832)
(cherry picked from commit 372ee27d49)

Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
2020-05-26 15:59:32 +03:00
Miss Islington (bot) c2a177adf3
bpo-39301: State that floor division is used for right shift operations (GH-20347) (GH-20415)
* bpo-39301: State that floor division is used for right shift operations

* Remove "without overflow check"
(cherry picked from commit af7553ac95)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-05-26 09:33:42 +01:00
Miss Islington (bot) b38bd8888a
bpo-40745: Fix typos in NewType docs (GH-20379)
(cherry picked from commit 2b0e654f91)

Co-authored-by: ziheng <zihenglv@gmail.com>
2020-05-25 21:52:55 -07:00
Miss Islington (bot) 1f2cc7cede
closes bpo-40774: Fix docs indentation for asyncio.create_subprocess_shell() (GH-20403)
(cherry picked from commit 4a0ac42c52)

Co-authored-by: sth <sth.dev@tejp.de>
2020-05-25 21:15:52 -07:00
Miss Islington (bot) 2fecb48a1d
bpo-40405: Fix asyncio.as_completed docs (GH-19753)
* Fix as_completed docs to correctly state the function return value.
* Also, improves the general wording of the as_completed documentation.

Co-Authored-By: Rémi Lapeyre <remi.lapeyre@henki.fr>
Co-Authored-By: Kyle Stanley <aeros167@gmail.com>
Co-Authored-By: Yury Selivanov <yury@edgedb.com>
(cherry picked from commit 13206b52d1)

Co-authored-by: Bar Harel <bzvi7919@gmail.com>
2020-05-23 16:24:03 -07:00
Miss Islington (bot) 0714c48719
Reword aware/naive introduction sentence (GH-20175)
This is more informative and avoids the question of whether the period should go inside or outside the quotation marks.

See also GH-20007.
(cherry picked from commit 2e76820a50)

Co-authored-by: Mathieu Dupuy <mathieu.dupuy@doctolib.com>
2020-05-22 14:43:51 -07:00
Miss Islington (bot) d88f0aa8e2
bpo-40651: Improve LRU recipe in the OrderedDict documentation (GH-GH-20139) (GH-20167) 2020-05-20 21:21:02 -07:00
Miss Islington (bot) 257e11cebd
bpo-39976: Add **other_popen_kwargs to subprocess docs (GH-20145)
(cherry picked from commit 46545000c2)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-05-19 02:27:49 -07:00
Miss Islington (bot) 7a3522d478
Doc: change 'Posix' for 'POSIX' (GH-20001)
(cherry picked from commit 65460565df)

Co-authored-by: Mathieu Dupuy <mathieu.dupuy@doctolib.com>
2020-05-17 14:37:30 -07:00
Miss Islington (bot) b1e23f3c32
Doc: move a dot outside double quotes (GH-20007)
(cherry picked from commit 4eba67783e)

Co-authored-by: Mathieu Dupuy <mathieu.dupuy@doctolib.com>
2020-05-17 14:32:43 -07:00
Miss Islington (bot) eb5ce324f7
bpo-38872: Document exec symbol for codeop.compile_command (GH-20047) (GH-20098)
* Document exec symbol for codeop.compile_command

* Remove extra statements

Co-authored-by: nanjekyejoannah <joannah.nanjekye@ibm.com>
(cherry picked from commit 7ba1f75f3f)

Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>

Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
2020-05-14 22:38:17 -03:00
Miss Islington (bot) 546f643487
Make the first dataclass example more useful (GH-19994) (GH-19997)
(cherry picked from commit 2effef7453)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2020-05-08 07:52:10 -04:00
Miss Islington (bot) 9609460ce0
Remove outdated and confusing advice about setting maxsize (GH-19889) (GH-19890) 2020-05-03 17:16:36 -07:00
Miss Islington (bot) 108e45524d
Fix missing space in docs(GH-19866) (GH-19872) 2020-05-02 17:05:49 -07:00
Miss Islington (bot) 399b9a4a62
bpo-40419: timeit CLI docs now mention 1,2,5,10,... trials instead of powers of 10 (GH-19752)
(cherry picked from commit 766352320f)

Co-authored-by: Sander <svr003@gmail.com>
2020-05-02 09:29:51 -07:00
Antoine Pitrou e05828055e
[3.8] bpo-39435: Fix docs for pickle.loads (GH-18160) (GH-19843)
(cherry picked from commit 289842a)

Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com>

Automerge-Triggered-By: @pitrou
2020-05-01 12:54:44 -07:00
Miss Islington (bot) c9d7d32b6d
bpo-39691: Clarify io.open_code behavior (GH-19824)
(cherry picked from commit 831d58d786)

Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com>
2020-05-01 11:04:25 -07:00
Miss Islington (bot) 179f22c3b7
bpo-40387: Improve queue join() example. (GH-19724) (GH-19726) 2020-04-26 18:23:14 -07:00
Miss Islington (bot) 22a4849cd8
Minor modernization and readability improvement to the tokenizer example (GH-19558) (GH-19661)
(cherry picked from commit bf1a81258c)
2020-04-22 13:50:32 -07:00
Miss Islington (bot) 7d65c045de
Small improvements to the recipes and examples. (GH-19635) (GH-19638)
* Add underscores to long numbers to improve readability
* Use bigger dataset in the bootstrapping example
* Convert single-server queue example to more useful multi-server queue
(cherry picked from commit d3a8d616fa)
2020-04-21 16:18:49 -07:00
Miss Islington (bot) 8c07343976
bpo-39285: Clarify example for PurePath.match (GH-19458)
Fixes Issue39285

The example incorrectly returned True for match.

Furthermore the example is ambiguous in its usage of PureWindowsPath.
Windows is case-insensitve, however the underlying match functionality
utilizes fnmatch.fnmatchcase.

Automerge-Triggered-By: @pitrou
(cherry picked from commit c12375aa0b)

Co-authored-by: Tim Lo <timlo@users.noreply.github.com>
2020-04-19 03:03:35 -07:00
Miss Islington (bot) 020f2aaaea
bpo-27635: Fix pickle documentation about `__new__` not being called. (GH-19269)
Automerge-Triggered-By: @pitrou
(cherry picked from commit 482259d0dc)

Co-authored-by: Furkan Önder <furkantahaonder@gmail.com>
2020-04-18 11:14:55 -07:00
Miss Islington (bot) 08b640f572
Fix parameter names in assertIn() docs (GH-18829)
The names "member" and "container" for the arguments are also used in the module and shown with the help() function, and are immediately understandable in this context, contrary to "first" and "second".
(cherry picked from commit a388bbd3f1)

Co-authored-by: Christoph Zwerschke <cito@online.de>
2020-04-16 19:06:11 -07:00
Miss Islington (bot) 3e72de9e08
[3.8] bpo-39667: Sync zipp 3.0 (GH-18540) (GH-18701)
* bpo-39667: Sync zipp 3.0 (GH-18540)

* bpo-39667: Improve pathlib.Path compatibility on zipfile.Path and correct performance degradation as found in zipp 3.0

* 📜🤖 Added by blurb_it.

* Update docs for new zipfile.Path.open

* Rely on dict, faster than OrderedDict.

* Syntax edits on docs

Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
(cherry picked from commit 0aeab5c438)

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>

* Clarify the change in behavior with a couple of workaround options.

* Restore API compatibility while backporting performance improvements.

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
2020-04-15 14:45:25 -04:00
Miss Islington (bot) ee691b078b
[3.8] Improved documentation for `BUILD_CONST_KEY_MAP` (GH-19454) (GH-19495)
(cherry picked from commit 85dd6bb1f6)


Co-authored-by: laike9m <laike9m@users.noreply.github.com>

Automerge-Triggered-By: @zhangyangyu
2020-04-12 20:01:53 -07:00
Miss Islington (bot) ceba0648d7
bpo-38501: Add a warning section to multiprocessing.Pool docs about resource managing (GH-19466)
(cherry picked from commit 7ec43a7309)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2020-04-10 19:11:17 -07:00
Serhiy Storchaka 0d1d7c8bae
bpo-36320: Use the deprecated-removed directive for _field_types (GH-19370) 2020-04-05 00:43:07 +03:00
Miss Islington (bot) e6783981df
bpo-40131: Fix source and target order in zipapp example (GH-19290) (GH-19339)
(cherry picked from commit bd6a4c3d72)


Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-04-03 22:43:58 +05:30
Miss Islington (bot) 77c623ba3d
bpo-40122: Updated documentation for dis.findlabels() (GH-19274)
(cherry picked from commit b74468e233)

Co-authored-by: laike9m <laike9m@users.noreply.github.com>
2020-04-03 01:07:16 -07:00
Miss Islington (bot) 267afc2ab2
bpo-40094: Enhance os.WIFEXITED documentation (GH-19244) (GH-19277)
(cherry picked from commit 7c72383f95)

Co-authored-by: Victor Stinner <vstinner@python.org>
2020-04-02 01:26:55 +02:00
Victor Stinner 40e1b04e38
Document most common signals (GH-19245) (GH-19257)
Document individual signals (only the most common signals):
description, default action, availability.

(cherry picked from commit 400e1dbcad)
2020-03-31 19:44:28 +02:00
Miss Islington (bot) 6c9a2a831e
fix comma location in various places (GH-19233)
(cherry picked from commit c49016e67c)

Co-authored-by: Mathieu Dupuy <deronnax@users.noreply.github.com>
2020-03-30 14:34:31 -07:00
Miss Islington (bot) 8dad09a224
bpo-19698: Document when importlib.machinery.FrozenImporter gained spec-related methods (GH-19158) (#19164)
(cherry picked from commit 302e5a8f79)

Co-authored-by: Brett Cannon <54418+brettcannon@users.noreply.github.com>

Co-authored-by: Brett Cannon <54418+brettcannon@users.noreply.github.com>
2020-03-26 10:15:05 -07:00
Miss Islington (bot) 2227c1a4ca
bpo-40013: Clarify documentation of restval in csv.DictReader (GH-19099) (GH-19141)
(cherry picked from commit 4b3252cb76)


Co-authored-by: Juhana Jauhiainen <juhana.jauhiainen@gmail.com>
2020-03-25 12:30:53 +05:30
Miss Islington (bot) 8cd48b60fd
Clarify a guarantee of the logging module. (GH-19132)
When no additional arguments are passed to logging.debug() and related
methods, no % operation is performed on the passed in message.
(cherry picked from commit 9b8e74ca77)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2020-03-24 09:54:40 -07:00
Miss Islington (bot) 687f5921a4
bpo-39652: Truncate the column name after '[' only if PARSE_COLNAMES is set. (GH-18942)
(cherry picked from commit b146568dfc)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2020-03-21 07:32:25 -07:00