Commit graph

21819 commits

Author SHA1 Message Date
Miss Islington (bot)
c76add7afd
Improve version added references in typing module docs (GH-13457)
(cherry picked from commit b7daabd711)

Co-authored-by: Anthony Sottile <asottile@umich.edu>
2019-06-01 17:23:40 -07:00
Miss Islington (bot)
fc914dd5e0
Doc: Correct the creation year and the credits of the Logo Programming language (GH-13520)
(cherry picked from commit 66501058fe)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2019-06-01 04:47:15 -07:00
Miss Islington (bot)
18e23f227b bpo-18911: clarify that the minidom XML writer receives texts but not bytes (GH-13718)
(cherry picked from commit 5ac0b988fd)

Co-authored-by: Windson yang <wiwindson@outlook.com>
2019-06-01 08:58:54 +02:00
Miss Islington (bot)
464c1ec65a
bpo-15115: Document deprecation of email.encoders in Python 3 (GH-5354)
(cherry picked from commit a747c3a5ed)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2019-05-31 13:26:01 -07:00
Miss Islington (bot)
fc3b8437c8
bpo-25735: math.factorial doc should mention integer return type (GH-6420)
(cherry picked from commit 4612671df2)

Co-authored-by: Akshay Sharma <akshay.sharma09695@gmail.com>
2019-05-31 09:58:27 -07:00
Miss Islington (bot)
8135455c84
bpo-37094: Add example for TestCase.skipTest in unittest doc (GH-13645)
Also includes other minor test skipping doc improvements.

https://bugs.python.org/issue37094
(cherry picked from commit ffed76b6fc)

Co-authored-by: Makdon <makdon@makdon.me>
2019-05-31 09:31:53 -07:00
Miss Islington (bot)
e8661c1dab
bpo-30969: Fix docs about the comparison in absence of __contains__ (GH-2761)
(cherry picked from commit 2f5b9dcc0a)

Co-authored-by: Antti Haapala <antti@haapala.name>
2019-05-30 13:41:06 -07:00
Miss Islington (bot)
4e1e887203
bpo-36794: Document that Lock.acquire is fair. (GH-13082)
https://bugs.python.org/issue36794
(cherry picked from commit 34f4f5efea)

Co-authored-by: Hrvoje Nikšić <hniksic@gmail.com>
2019-05-29 11:24:32 -07:00
Miss Islington (bot)
cee95fe182
bpo-36739: Update controlflow.rst (GH-12983)
in addition to global-statement also mention nonlocal-statement
(in the paragraph describing access to variables which are non local to a function
(cherry picked from commit e1f95e77e0)

Co-authored-by: pbhd <p-bauer-schriesheim@t-online.de>
2019-05-28 20:48:12 -07:00
Miss Islington (bot)
8ea0fd85bc bpo-26903: Limit ProcessPoolExecutor to 61 workers on Windows (GH-13132) (GH-13643)
Co-Authored-By: brianquinlan <brian@sweetapp.com>
(cherry picked from commit 39889864c0)

Co-authored-by: Brian Quinlan <brian@sweetapp.com>
2019-05-28 23:12:30 -04:00
Miss Islington (bot)
218abd109c
Docs: FIX broken links. (GH-13491)
(cherry picked from commit 7114c6504a)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-05-28 16:09:14 -07:00
karl ding
d6a14a1483 [3.7] Fix typo in docs for socket.CAN_RAW_FD_FRAMES (GH-13635) (GH-13637)
There is an extra "one" in the text description for the constant
socket.CAN_RAW_FD_FRAMES
(cherry picked from commit 1b05aa2190)
2019-05-28 12:32:12 -07:00
Miss Islington (bot)
95b7706a95
Doc: Add missing forward reference in the tutorial. (GH-13499)
(cherry picked from commit 51ddab8dae)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-05-28 06:20:58 -07:00
Miss Islington (bot)
1cfb90b69f
Doc: Space breaking whole definition. (GH-13615)
(cherry picked from commit 0811f2d81a)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-05-28 05:28:34 -07:00
Miss Islington (bot)
a6733fd0a2
Remove outdated time.monotonic reference (GH-13264)
Per ae58649, time.monotonic is always available, making the old note outdated.
(cherry picked from commit 293e9f86b8)

Co-authored-by: Brad <brad.solomon.1124@gmail.com>
2019-05-28 03:56:05 -07:00
Miss Islington (bot)
d57bb1c2f7
Fix broken :ref: in asyncio docs (GH-11805)
(cherry picked from commit 5033e315d2)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2019-05-27 21:22:25 -07:00
Miss Islington (bot)
abdda3ae2a
bpo-37039: IDLE - zoomheight fixes (GH-13576)
Move doc entry to match menu and refactor zoom function.
A followup patch will include a blurb.
(cherry picked from commit df9b032f47)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2019-05-27 16:48:04 -07:00
Miss Islington (bot)
e8318f31f3 bpo-37051: Refine note on what objects are hashable (GH-13587) (GH-13595)
(cherry picked from commit cc1c582f6f)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-05-27 10:43:18 -07:00
Miss Islington (bot)
310f414bbd
bpo-23395: Fix PyErr_SetInterrupt if the SIGINT signal is ignored or not handled (GH-7778)
``_thread.interrupt_main()`` now avoids setting the Python error status if the ``SIGINT`` signal is ignored or not handled by Python.
(cherry picked from commit 608876b6b1)

Co-authored-by: Matěj Cepl <mcepl@cepl.eu>
2019-05-24 02:22:38 -07:00
Miss Islington (bot)
a3488e5902
bpo-36797: Reduce levels of indirection in outdated distutils docs (GH-13462)
(cherry picked from commit e788057a91)

Co-authored-by: Nick Coghlan <ncoghlan@gmail.com>
2019-05-23 07:19:41 -07:00
Victor Stinner
a58db9628d
bpo-36829: Enhance PyErr_WriteUnraisable() (GH-13487)
PyErr_WriteUnraisable() now displays the exception even if displaying
the traceback failed. Moreover, hold a strong reference to sys.stderr
while using it.

Document that an exception must be set when calling
PyErr_WriteUnraisable(), but don't add an assertion to check it at
runtime.

Cleanup: use longer names for variables and create
write_unraisable_exc_file() subfunction.
2019-05-22 18:23:28 +02:00
Tal Einat
390d88e49c
[3.7] bpo-19376: Added doc mentioning datetime.strptime() without a year fails for Feb 29. (GH-10243)
(cherry picked from commit 56027ccd6b)

Co-authored-by: Abhishek Kumar Singh <toanant@users.noreply.github.com>
2019-05-21 22:03:58 +03:00
Geoff Shannon
cdb2dbfe92 [3.7] bpo-22865: Expand on documentation for the pty.spawn function (GH-11980) (GH-13455)
(cherry picked from commit 522ccef869)

Co-authored-by: Geoff Shannon <earthlingzephyr@gmail.com>
2019-05-21 11:36:57 +02:00
Miss Islington (bot)
2d94d4f1a5
bpo-36958: In IDLE, print exit message (GH-13435)
Print any argument other than None or int passed to SystemExit
or sys.exit().
(cherry picked from commit 6d965b39b7)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2019-05-20 00:16:53 -07:00
Miss Islington (bot)
205c1f0e36 bpo-34580: Update sqlite3 examples to call close() explicitly (GH-9079)
The sqlite3.Connection object doesn't call its close() method when it's used
as a context manager.

(cherry picked from commit 287b84de93)

Co-authored-by: Xtreak <tir.karthi@gmail.com>
2019-05-20 01:36:32 +03:00
Miss Islington (bot)
f81b33bada
Orthographical fix (GH-13418)
Add a missing comma.
(cherry picked from commit 1d5bdef550)

Co-authored-by: Boštjan Mejak <bostjan.xperia@gmail.com>
2019-05-19 02:13:28 -07:00
Miss Islington (bot)
951b161857
bpo-36783: Add new references for C API Documentation changes (GH-13204)
(cherry picked from commit d28772ab69)

Co-authored-by: Edison A <20975616+SimiCode@users.noreply.github.com>
2019-05-18 19:12:01 -07:00
Miss Islington (bot)
561c63cd70
Fixed typo (GH-11522)
Given example does not run, loop variable is missing.

Secondly, this is bad example how to handle shutdown signal, because it would cause `RuntimeError: Event loop stopped before Future completed.`

Perhaps it would be better to cancel all tasks instead of closing loop directly?

Did not create issue, because question is quite simple.
(cherry picked from commit ceb842e155)

Co-authored-by: Alexander Vasin <hi@alvass.in>
2019-05-18 02:48:47 -07:00
Miss Islington (bot)
740a7cde9c
bpo-36908: 'This module is always available' isn't helpful. (GH-13297)
Makes the documentation of math and cmath module
more helpful for the beginners.
(cherry picked from commit 6faad355db)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2019-05-17 14:08:21 -07:00
Miss Islington (bot)
a22c42fea6
docs 36789: resolve incorrect note regarding UTF-8 (GH-13111)
(cherry picked from commit f98c3c59c0)

Co-authored-by: redshiftzero <jen@freedom.press>
2019-05-17 04:01:47 -07:00
Miss Islington (bot)
4be0720beb
Doc: Add link threading.settrace to sys.settrace (GH-13345)
(cherry picked from commit 245f528a92)

Co-authored-by: Stefan Hoelzl <stefan.hoelzl@posteo.de>
2019-05-17 02:02:51 -07:00
Miss Islington (bot)
876756e4a1
Fix typos in documentation. Patch by tirkarthi. (GH-13354)
(cherry picked from commit 8a533ffb49)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2019-05-15 22:38:31 -07:00
Stéphane Wirtel
4fd7f56ee7
[3.7] bpo-36799: Fix typo in ctypes.rst (GH-13104) (GH-13341)
(cherry picked from commit 133fc89ca)

Co-authored-by: Yavor Konstantinov <7553015+sehnsucht13@users.noreply.github.com>
2019-05-15 17:53:25 +02:00
Miss Islington (bot)
822683238c
bpo-36760: Clarify subprocess capture_output docs. (GH-13322)
Clarify how to capture stdout and stderr combined into one stream.
(cherry picked from commit e883091abf)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2019-05-14 12:39:17 -07:00
Miss Islington (bot)
8b3823ae16
bpo-32995 - Added context variable in glossary (GH-9741)
(cherry picked from commit c0a1a07c7e)

Co-authored-by: Vinodhini Balusamy <me.vinob@gmail.com>
2019-05-14 05:24:42 -07:00
Miss Islington (bot)
da86bf7396
Changes to the documentation of normcase (GH-4725)
(cherry picked from commit 32d1458b2e)

Co-authored-by: Kexuan Sun <me@kianasun.com>
2019-05-13 19:21:25 -07:00
Miss Islington (bot)
7f485ea4fc
bpo-35138: Added an example for timeit.timeit with callable arguments (GH-9787)
* Update timeit.rst
(cherry picked from commit 8da5ebe11e)

Co-authored-by: Anders Hovmöller <boxed@killingar.net>
2019-05-13 12:41:31 -07:00
Miss Islington (bot)
ee9b5ce390
Docs: Add bz2 usage examples (GH-13258)
* Docs: Add bz2 usage examples

- Adds an "Examples of usage" section inspired by the one
  found in the gzip docs
- Corrects the descriptions for ``compresslevel`` and ``data``:
    - ``compresslevel`` must be an `int`, not any number.  For
      instance, passing a float will raise ``TypeError``
    - Notes that `data` must be bytes-like
(cherry picked from commit be6939fb02)

Co-authored-by: Brad <brad.solomon.1124@gmail.com>
2019-05-13 11:50:16 -07:00
Matthias Bussonnier
24482bd0ae [3.7] bpo-36895: document time.clock() has been removed in 3.8 (GH-13287) 2019-05-13 18:08:48 +02:00
Stéphane Wirtel
074d7c44a4 [3.7] bpo-34682: Wording and grammatical changes to the doc(https://docs.python.org/3) (GH-13120) (GH-13281)
https://bugs.python.org/issue34682
(cherry picked from commit 778a910758)

Co-authored-by: divyag9 <divyam9@gmail.com>
2019-05-13 15:48:49 +02:00
Miss Islington (bot)
af5ef3e107 bpo-33882: mention breakpoint() in debugger-related FAQ (GH-7759) (GH-13077)
(cherry picked from commit cf48e55f7f)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-05-13 15:03:10 +02:00
Sanyam Khurana
4f5febdf95 [3.7] bpo-36822: Fix minor grammatical error in glossary.rst (GH-13145). (GH-13260)
(cherry picked from commit 90fb04c1e2)

Co-authored-by: Sanyam Khurana <8039608+CuriousLearner@users.noreply.github.com>
2019-05-12 04:53:02 +01:00
Miss Islington (bot)
069a5b4833
bpo-33071: remove outdated PyPI docs (GH-13087)
Patch by Kojo Idrissa.
(cherry picked from commit 1b4abcf302)

Co-authored-by: Kojo Idrissa <kojoidrissa@users.noreply.github.com>
2019-05-10 01:50:54 -07:00
Miss Islington (bot)
98b360e27b
[3.7] bpo-10536: Enhancements to gettext docs (GH-10324) (GH-13224)
(cherry picked from commit 55f3317e98)


Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>


https://bugs.python.org/issue10536
2019-05-09 13:26:09 -07:00
Miss Islington (bot)
ed8860c5af
bpo-31873: Update unicode.rst - 'unicode' capitalization (GH-4125)
Update 'unicode' capitalization. 'Unicode' is a proper noun, and as such should be capitalized.
Changed multiple instances.
(cherry picked from commit 85225b6a58)

Co-authored-by: toonarmycaptain <toonarmycaptain@hotmail.com>
2019-05-08 09:34:12 -07:00
Miss Islington (bot)
5e08fe18a7
Doc: Be explicit that Pathlib resolve was strict before 3.6. (GH-11316)
(cherry picked from commit 1d4b16051f)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-05-08 08:26:23 -07:00
Miss Islington (bot)
3afbe69988
[3.7] Doc: Fix missing bracket (GH-13163) (GH-13189)
(cherry picked from commit 70b80541bb)


Co-authored-by: Zhaorong Ma <mazhaorong@gmail.com>
2019-05-08 07:07:02 -07:00
Miss Islington (bot)
5edd82c806 Add a footnote about Cheese Shop in Doc/tutorial (GH-13103) (GH-13174)
(cherry picked from commit e19a91e45f)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2019-05-07 21:59:20 +01:00
Miss Islington (bot)
1fe722cf14
[3.7] bpo-11001: updated cookie docs (GH-13086) (GH-13161)
Used **spookylukey**'s patch from 2011-01-24



https://bugs.python.org/issue11001
(cherry picked from commit 91cc01f40e)


Co-authored-by: Julia Iliuk <julia.iluyk@gmail.com>


https://bugs.python.org/issue11001
2019-05-07 10:32:45 -07:00
Miss Islington (bot)
721729fca4
bpo-28795: Signal documentation: Fix misleading statement. (GH-13121)
(cherry picked from commit e85ef7a7ea)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-05-07 08:55:39 -07:00