Commit Graph

22883 Commits

Author SHA1 Message Date
Miss Islington (bot) 12bb0b69ec
Update ssl.rst 2020-06-29 00:34:35 -07:00
Miss Islington (bot) ea164309de
bpo-41123: Doc: PyLong_FromUnicode will be removed in 3.10 (GH-21205)
(cherry picked from commit 02134dae44)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2020-06-28 22:36:04 -07:00
Ned Deily 7318f0ab23
bpo-40204: Pin Sphinx version to 2.3.1 in ``Doc/Makefile``. (GH-21141) (GH-21147) 2020-06-25 07:44:14 -04: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
Ammar Askar 6eab52ffad
bpo-39699: Remove accidentally committed test change (GH-21089) 2020-06-23 19:28:25 +01: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) a4c09560ea
Add link to .pypirc specification (GH-20680) (#21019)
Related to https://github.com/pypa/twine/issues/638 and https://github.com/pypa/packaging.python.org/issues/730, I wrote a spec based on the one that was removed in https://github.com/python/cpython/pull/13087. However, a Google search for "pypirc" turned up at least one [blog post](https://truveris.github.io/articles/configuring-pypirc/) that links to https://docs.python.org/3/distutils/packageindex.htmlGH-the-pypirc-file, which now just links to this document. So, I thought a link to the spec would be handy.

Automerge-Triggered-By: @jaraco
(cherry picked from commit af157fad28)

Co-authored-by: Brian Rutledge <brian@bhrutledge.com>

Co-authored-by: Brian Rutledge <brian@bhrutledge.com>
2020-06-20 17:12:27 -04: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) 14073c5090
bpo-24914: mention Python supports multiple paradigms in the FAQ (GH-20658) (GH-20738)
(cherry picked from commit 3ab3475c42)

Co-authored-by: Brett Cannon <brett@python.org>

Co-authored-by: Brett Cannon <brett@python.org>
2020-06-08 11:53:25 -07: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) 139f1bafcf
Ensure correct version of Sphinx is used for Windows builds (GH-20582)
(cherry picked from commit fe5dd78182)

Co-authored-by: Steve Dower <steve.dower@python.org>
2020-06-01 14:25:32 -07:00
Miss Islington (bot) d0dc369a90
bpo-40831: Remove an incorrect statement in the Windows docs (GH-20570)
(cherry picked from commit c8966667bb)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-06-01 08:53:33 -07:00
Miss Islington (bot) ba1c2c85b3
bpo-40798: Generate a different message for already removed elements (GH-20483)
(cherry picked from commit 735d902b36)

Co-authored-by: Florian Dahlitz <f2dahlitz@freenet.de>
2020-05-30 00:54:58 -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) c0c5db54cf
Improve IO tutorial's "Old string formatting" section (GH-16251)
* Use a more universal explanation of string interpolation rather than specifically referencing sprintf(), which depends on the reader having a C background.

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

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2020-05-27 18:41:31 -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) 331b2dfadb
bpo-38972: Fix typos in PowerShell Execution Policies links (GH-20383)
(cherry picked from commit ef16958d17)

Co-authored-by: Miro Hrončok <miro@hroncok.cz>
2020-05-25 08:11:39 -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) dc3239177f
bpo-40439: Update broken link in lexical analysis docs (GH-20184)
Automerge-Triggered-By: @csabella
(cherry picked from commit af23f0d3cf)

Co-authored-by: Matteo Bertucci <matteobertucci2004@gmail.com>
2020-05-22 18:20:01 -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) 822efa5695
[doc] Remove references to obsolete BuildApplet on macOS. (GH-20023)
(cherry picked from commit 7864f11cdf)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-05-21 16:34:46 -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) b5279c1ab8
Doc: Python 3.10 in sidebar and version switcher. (GH-20209)
(cherry picked from commit 19e3e00264)

Co-authored-by: Julien Palard <julien@palard.fr>
2020-05-19 05:34:01 -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
Pablo Galindo 71e6122b44
bpo-39562: Correctly updated the version section in the what's new document (GH-19838) 2020-05-01 16:36:51 +01:00
Pablo Galindo 5055c274c6
[3.8] bpo-39562: Prevent collision of future and compiler flags (GH-19230) (GH-19835)
The constant values of future flags in the __future__ module
is updated in order to prevent collision with compiler flags.
Previously PyCF_ALLOW_TOP_LEVEL_AWAIT was clashing
with CO_FUTURE_DIVISION..
(cherry picked from commit 4454057269)

Co-authored-by: Batuhan Taşkaya <batuhanosmantaskaya@gmail.com>
2020-05-01 07:18:27 -07:00
Miss Islington (bot) 9412f4d1ad
bpo-40348: Fix typos in the programming FAQ (GH-19729)
(cherry picked from commit caf1aadf3d)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-04-26 20:29:30 -07:00
Zachary Ware ca5649c4c1
[3.8] bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros (GH-16607) (GH-19727)
Adds a short description of `PyDoc_STRVAR` and `PyDoc_STR` to "Useful macros" section of C-API docs.

Currently, there is [one lone mention](https://docs.python.org/3/c-api/module.html?highlight=pydoc_strvarGH-c.PyModuleDef) in the C-API reference, despite the fact that `PyDoc_STRVAR` is ubiquitous to `Modules/`.

Additionally, this properly uses `c:macro` within `Doc/c-api/module.rst` to link.
(cherry picked from commit b54e46c)

Authored-by: Brad Solomon <brad.solomon.1124@gmail.com>
2020-04-26 21:45:05 -05: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) 882a7f44da
bpo-40279: Add some error-handling to the module initialisation docs example (GH-19705) (GH-19710)
(cherry picked from commit d4f3923d59)

Co-authored-by: Cajetan Rodrigues <caje731@gmail.com>
2020-04-25 07:45:48 +02:00