Commit graph

9308 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)
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)
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)
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)
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
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)
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)
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)
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
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)
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)
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
penguindustin
b2d29bfa5b [3.7] bpo-36766: Typos in docs and code comments (GH-13116). (GH-13136)
(cherry picked from commit 9646630895)

Co-authored-by: penguindustin <penguindustin@gmail.com>





https://bugs.python.org/issue36766
2019-05-06 13:55:19 -07:00
Miss Islington (bot)
9a03c77328
bpo-36275: enhance documentation for venv.create() (GH-13114)
(cherry picked from commit 3921b1cc34)

Co-authored-by: Sebastian Koslowski <sebastian.koslowski@gmail.com>
2019-05-06 12:25:59 -07:00
Miss Islington (bot)
5d90954856
Syntax highlight IDLE html doc code example. (GH-12981)
The new markup is currently ignored by IDLE's tk doc display.
(cherry picked from commit 55d035113d)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2019-04-26 20:42:05 -07:00
Miss Islington (bot)
e64d21b187
replace 'sequencial argument' by 'positional' in doc (GH-12925)
(cherry picked from commit 29d018aa63)

Co-authored-by: Mathieu Dupuy <deronnax@users.noreply.github.com>
2019-04-23 06:06:57 -07:00
Miss Islington (bot)
71b88827f6
bpo-36645: Fix ambiguous formatting in re.sub() documentation (GH-12879)
(cherry picked from commit 5ebfa840a1)

Co-authored-by: mollison <mollison@cs.unc.edu>
2019-04-21 15:20:45 -07:00
Miss Islington (bot)
307e7a4264
Fix typo (GH-12878)
"sychronization" -> "synchronization"
(cherry picked from commit 3e986de0d6)

Co-authored-by: Fredrik Averpil <fredrik@averpil.com>
2019-04-20 16:12:23 -07:00
Miss Islington (bot)
d29b3dd922
bpo-36651: Fixed Asyncio Event Loop documentation inconsistency (GH-12866)
GH- [bpo-36651](https://bugs.python.org/issue36651): Fixed Asyncio Event Loop documentation inconsistency

In the documentation for the call_later and the call_at methods there is a note which says that the delay cannot be longer than a day, but both methods have a note saying that this limitation was removed in Python 3.8
Here I fixed this issue by removing the pre-exising note and added a versionchanged.

To test my changes I have rebuilt the documentation with ```make html```. I did not have any errors and the effected page displayed correctly on a browser.

https://bugs.python.org/issue36651
(cherry picked from commit 7e954e7de4)

Co-authored-by: Enrico Alarico Carbognani <enrico.carbognani@gmail.com>
2019-04-18 05:49:24 -07:00
Miss Islington (bot)
21c8caa16a
Fix wrong indentation of a paragraph in documentation (GH-12868)
This paragraph doesn't seem to be a part of code, but merged into previous code block.
(cherry picked from commit 9941f963fe)

Co-authored-by: cocoatomo <cocoatomo77@gmail.com>
2019-04-17 18:00:37 -07:00
Miss Islington (bot)
a6fce19968 bpo-33783: Use proper class markup for random.Random docs (GH-7817) (GH-12859)
Signed-off-by: Matthias Bussonnier <bussonniermatthias@gmail.com>
(cherry picked from commit 31e8d69bfe)

Co-authored-by: Matthias Bussonnier <bussonniermatthias@gmail.com>
2019-04-16 23:32:32 +02:00
Miss Islington (bot)
871ba6c848
Doc: update PendingDeprecationWarning explanation (GH-12837)
Keep the nudge towards DeprecationWarning, but remove the
"Note" markup and generally shorten the description.

Ref: https://github.com/python/cpython/pull/12505/filesGH-r273978757
(cherry picked from commit a3283efd30)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2019-04-15 05:48:31 -07:00
Miss Islington (bot)
b759a2c5b9
bpo-35581: Document @typing.type_check_only (GH-11312)
(cherry picked from commit 1e8295402b)

Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
2019-04-12 15:47:57 -07:00
Miss Islington (bot)
a910c2c6f3
bpo-34839: Add a 'before 3.6' in the section 'warnings' of doctest (GH-9736)
(cherry picked from commit 0522fd81dc)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2019-04-11 23:27:27 -07:00
Inada Naoki
ac31da8f37
bpo-36597: fix random doctest failure (GH-12778) 2019-04-11 19:37:53 +09:00
Miss Islington (bot)
04b114eede
bpo-36416: Correct bytes.rpartition documentation (GH-12543)
(cherry picked from commit efc4870149)

Co-authored-by: pewscorner <pewscorner@users.noreply.github.com>
2019-04-11 03:18:48 -07:00
Miss Islington (bot)
a8c4fa5319
Doc: fix typo in IncrementalDecoder.setstate (GH-12724)
(cherry picked from commit b5e2959b27)

Co-authored-by: Christopher Thorne <libcthorne@users.noreply.github.com>
2019-04-10 23:18:07 -07:00
Miss Islington (bot)
9d2ccf173e
bpo-14826: document that URLopener quotes fullurl. (GH-12758)
(cherry picked from commit 2fb2bc81c3)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2019-04-10 02:30:22 -07:00
Miss Islington (bot)
0a16bb15af
closes bpo-35848: Move all documentation regarding the readinto out of IOBase. (GH-11893)
Move all documentation regarding the readinto method into either io.RawIOBase or io.BufferedIOBase.

Corresponding changes to documentation in the _pyio.py module.
(cherry picked from commit 7b97ab35b2)

Co-authored-by: Steve Palmer <steve@srpalmer.me.uk>
2019-04-08 21:57:31 -07:00