Commit Graph

21558 Commits

Author SHA1 Message Date
Miss Islington (bot) 34fcee9ed8
bpo-23220: Explain how IDLE's Shell displays output (GH-10356)
Add a new subsection to the doc.
(cherry picked from commit 75d9d59ab3)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-11-06 10:27:20 -08:00
Miss Islington (bot) a437c285fa
bpo-35099: Improve the doc about IDLE running user code. (GH-10350)
The section is renamed from "IDLE -- console differences".  It mostly
covers the implications of using custom sys.stdxxx objects.
(cherry picked from commit 5e79090324)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-11-05 18:35:18 -08:00
Miss Islington (bot) 558dc8adbe
bpo-35119: Fix RecursionError in example of customizing module attribute access. (GH-10323)
https://bugs.python.org/issue35119
(cherry picked from commit 0bee3c36d4)

Co-authored-by: Denis Osipov <osipov_d@list.ru>
2018-11-05 17:59:15 -08:00
Miss Islington (bot) 91a19c923c
[Docs] Fix required version of an example of importlib (GH-10118)
§31.5.6.3. Importing a source file directly: `module_from_spec` is new in Python 3.5.
(cherry picked from commit 16c8a53490)

Co-authored-by: E Kawashima <e-kwsm@users.noreply.github.com>
2018-11-05 14:46:42 -08:00
Serhiy Storchaka 6ad277b259
[3.7] bpo-35167: Specify program for json.tool command line options. (GH-10332) (GH-10338)
(cherry picked from commit 083a7a172b)
2018-11-05 18:44:08 +02:00
Miss Islington (bot) 133fd6527d
Fix a typo about a comma. (GH-10306)
(cherry picked from commit fe62d877e3)

Co-authored-by: İsmail Arılık <arilik.ismail@gmail.com>
2018-11-03 10:41:38 -07:00
Miss Islington (bot) b9c48a73bc
Include memo in the documented signature of copy.deepcopy()
* Include memo in the documented signature of copy.deepcopy()

The memo argument is mentioned lower on the doc page under writing a
`__deepcopy__` method, but is not included in the documented function signature.
This makes it easy to miss, and can lead to incorrect/buggy implementations of
`__deepcopy__` -- which is exatly what just happpend to me!
(cherry picked from commit 0200928e8d)

Co-authored-by: Stephan Hoyer <shoyer@gmail.com>
2018-11-01 14:35:17 -07:00
Miss Islington (bot) d69f015ba5
Doc: fix asyncio loop.close() description (GH-10229)
Needs backport to 3.7. In 3.6 the description is correct.
(cherry picked from commit b83d917faf)

Co-authored-by: Andriy Maletsky <andriy.maletsky@gmail.com>
2018-11-01 14:34:42 -07:00
Miss Islington (bot) 7d35553138
bpo-35075: Fix broken url in the pprint documentation (GH-10201)
https://bugs.python.org/issue35075
(cherry picked from commit bf46a09dec)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2018-11-01 14:33:52 -07:00
Serhiy Storchaka b183750f99
[3.7] bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231). (GH-10253)
(cherry picked from commit 3f819ca138)
2018-10-31 11:00:24 +02:00
matthewbelisle-wf aa0a21a7c8 bpo-35116, urllib.parse: Document the new max_num_fields parameter (GH-10246) 2018-10-30 22:15:24 +01:00
Miss Islington (bot) f51ef51db6
bpo-35086: Fix tkinter example "A Simple Hello World Program". (GH-10160)
The root widget was accessed as a global variable in the Application's method.
(cherry picked from commit a80af77087)

Co-authored-by: Daniel Lovell <lovell.daniel92@gmail.com>
2018-10-30 08:34:54 -07:00
Miss Islington (bot) a02bc719eb
bpo-27741: Better wording for datetime.strptime() (GH-9994)
(cherry picked from commit c0799ec973)

Co-authored-by: Gus Goulart <augusto@goulart.me>
2018-10-29 04:55:08 -07:00
Miss Islington (bot) 1a3f18e2c5
bpo-35097: Add IDLE doc subsection explaining editor windows. (GH-10206)
Topics include opening, title and status bar, .py* extension, and running.
(cherry picked from commit ea9c8bd443)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-10-28 18:51:33 -07:00
Miss Islington (bot) ff8d626f3a
Issue 35093: Document the IDLE document viewer in the IDLE doc. (GH-10195)
Add a paragraph in "Help and preferences", "Help sources" subsection.
(cherry picked from commit 18032632ab)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-10-28 13:39:38 -07:00
Miss Islington (bot) 8dccb00c19
bpo-1529353: Explain Shell text squeezing in the IDLE doc. (GH-10169)
(cherry picked from commit 68d6dc0770)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-10-28 10:03:19 -07:00
Miss Islington (bot) fdf48b6b88 bpo-35054: Add yet more index entries for symbols. (GH-10121) (GH-10171)
(cherry picked from commit 913876d824)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-10-28 18:43:32 +02:00
Miss Islington (bot) c516dc6e57
bpo-35089: Don't mention typing.io and typing.re (GH-10173)
https://bugs.python.org/issue35089
(cherry picked from commit c8a8d6b347)

Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
2018-10-28 09:16:36 -07:00
Miss Islington (bot) 50e04cc273
Fix mistakes on function coroutines related definitions (GH-9871)
Fix a bug I introduced in GH-9864 by which coroutines are treated as synonymous of function coroutines.

Also, fix the same mistake (coroutines == function coroutines) already present in other parts of the reference.

I'm very sorry for the hassle.
(cherry picked from commit 95f68b10d5)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-10-28 06:52:27 -07:00
Miss Islington (bot) c73cd4e05a Fix typo in zipfile documentation. (GH-10151) (GH-10153)
(cherry picked from commit 40bf6cff22)

Co-authored-by: nsrip <nick.ripley@me.com>
2018-10-27 23:06:46 +03:00
Miss Islington (bot) 6f82bdc6e0
unittest documentation: Spell pytest without the dot (GH-9820)
Referring to ``pytest`` as ``py.test`` is deprecated.
(cherry picked from commit d855f2fdbd)

Co-authored-by: Andreas Pelme <andreas@pelme.se>
2018-10-27 11:17:15 -07:00
Miss Islington (bot) cb920c1442
bpo-35079: Revise difflib.SequenceManager.get_matching_blocks doc (GH-10144)
Specify that blocks are non-overlapping. Change '!=' to '<'.
(cherry picked from commit d9bff4e81b)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-10-26 20:07:42 -07:00
Miss Islington (bot) f2b5b4f259
Fix a typo in asyncio-dev.rst. (GH-10133)
"threadsafe"
(cherry picked from commit 4e3a53bcee)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2018-10-26 10:42:49 -07:00
Senthil Kumaran bb1876acd8
[3.7] bpo-34576 : Backport eeab510 (#10114)
* bpo-34576 - Fix the formatting for security considerations in http.server.rst (#10005)

(cherry picked from commit eeab510bb7)
2018-10-26 10:11:39 -07:00
Andrés Delfino 1487b651ca [3.7] bpo-34789: xml.sax.make_parser expects a list not just any sequence (GH-9542) 2018-10-26 16:12:02 +03:00
Miss Islington (bot) ec10b70ea6
bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)
(cherry picked from commit e483f02423)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-10-26 03:56:28 -07:00
Serhiy Storchaka 9a75b8470a
[3.7] bpo-35054: Add more index entries for symbols. (GH-10064). (GH-10120)
(cherry picked from commit ddb961d2ab)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-10-26 11:18:42 +03:00
Miss Islington (bot) c64c4056c1
bpo-35038: AttributeError: 'frame' object has no attribute 'f_restricted'. (GH-10098)
https://bugs.python.org/issue35038
(cherry picked from commit 1770d1c512)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-10-25 14:19:31 -07:00
Miss Islington (bot) b322394009
configparser doc: Properly label ConfigParser attributes (GH-9930)
(cherry picked from commit 890423f796)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2018-10-24 16:56:25 -07:00
Miss Islington (bot) 917efd8d7b
importlib doc: Fix approximated import_module() code (GH-9945)
The spec gets stored on modules with the __spec__ attribute, not spec.
(cherry picked from commit 78401f7156)

Co-authored-by: orlnub123 <orlnub123@gmail.com>
2018-10-24 16:38:00 -07:00
Miss Islington (bot) f2679afda0
bpo-35027, distutils doc: Correct note on setup.py change in Python 3.7 (GH-10032)
(cherry picked from commit e80e77a484)

Co-authored-by: TilmanK <tilman.krummeck@googlemail.com>
2018-10-24 15:59:15 -07:00
Miss Islington (bot) d9dbb864cd
Use f-strings in asyncio-task code examples (GH-10035)
Replace str.format with f-strings in the code examples of asyncio-task documentation.
(cherry picked from commit 9f43fbbd9d)

Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
2018-10-24 15:45:44 -07:00
Tal Einat b4c9874f5c [3.7] bpo-33899: Mention tokenize behavior change in What's New (GH-10073) (GH-10074)
(cherry picked from commit dfba1f67e7)


https://bugs.python.org/issue33899
2018-10-24 00:33:00 -07:00
Zsolt Cserna 861f61b5a9 [3.7] bpo-34260, shutil: fix copy2 and copystat documentation (GH-8523) (GH-10065)
Fix the documentation of copy2, as it does not copy file ownership (user and
group), only mode, mtime, atime and flags.

The original text was confusing to developers as it suggested that this
command is the same as 'cp -p', but according to cp(1), '-p' copies file
ownership as well.

Clarify which metadata is copied by shutil.copystat in its docstring.

(cherry picked from commit 4f399be0e7)
2018-10-23 23:57:55 +02:00
Miss Islington (bot) fc62c7223e
bpo-34748: link to :ref:`partial-objects` in functools.partial doc. (GH-9809)
(cherry picked from commit 83a07652e0)

Co-authored-by: Andrei Petre <p31andrei@gmail.com>
2018-10-22 23:16:42 -07:00
Ned Deily 08eae4fa4c Python 3.7.1
-----BEGIN PGP SIGNATURE-----
 
 iQIzBAABCgAdFiEEDZbfTUEQ5cQ/v7F/LTR+pqplQh0FAlvKxbwACgkQLTR+pqpl
 Qh1gIxAAs6/Ry7GirNwzVrKv6HG/GYFB61OaqmO2BMRRuFB226iQjdM1Amaw5I3m
 Dbe4rPrQWXPaI7UIMrbA/oK1BH5AZgpKcVr5YbXF3uAb3AN05E9iNGVbR+qQMlsd
 +3ydWrDcKzRJnVZxaUlLVZdEpaDXsAkAJTfOBNvwdfncBtPXa1+tbuT0SY6yGFwb
 NNq+BvYZJJKuWQ3s10zv5dnUiUlLJMLiVP0pZjwVS2d/gG2gs/rEzz2fBJKygjYR
 TTGhS69KGpqYOLq9USmUzI7DJNts7YeNhhiwF/X7qOx4y2n2dRz721SGlG+Nkxt6
 kvRv3LaLRKsBlPjoVHFyRwIlr4uc3JfwFL3ngswfUNgChrqxkEZgV4oouxeSVQ5o
 Yi/GGBA+c9xvdgufnaKgt8Ep30XRS7vfQZ8KeFwH2xWNCIglVHdBffwwlbwUWft5
 t3/udHDXdeUu7Yb7hfamaA5pafH5lwoQMlbSwOl9gg94sNNuERhocoi8IpMDhzDs
 cI7Jw8sAPWipn6F7k2rn8Z8RFWZEJr4XtgZs/+jTxS3DVfuV3EDYIlM2V/4SXK/b
 KCJ/4NqDjGEFyrSZ0/d5GnmE3dvWrYztUebotFvv2q2aPEv9u8n66BxH/pSLNFTJ
 CtITqOsRwU8IdeOIET0246Oi8Ha4ZU/qQdnPqv5bktD69qAxSOQ=
 =qLkl
 -----END PGP SIGNATURE-----

Merge tag 'v3.7.1' into 3.7
2018-10-20 12:54:48 -04:00
Miss Islington (bot) 34a5ed5c0a
bpo-35032: Remove inaccessible videos from faq/Windows (GH-10004)
https://bugs.python.org/issue35032
(cherry picked from commit d262250d07)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-10-20 08:32:28 -07:00
Ned Deily 32fe7b0188 bpo-34576: Revert doc change until it can be properly fixed (GH-9720)
This reverts commit 57038bcb24.
2018-10-20 00:49:35 -04:00
Miss Islington (bot) 557a68789b
bpo-32798: Add restriction on the offset parameter for mmap.flush in the docs (GH-5621)
Add restriction on the offset parameter for mmap.flush.

Explain that ALLOCATIONGRANULARITY is the same as PAGESIZE in Unix.
(cherry picked from commit 027664a3d5)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2018-10-19 17:48:05 -07:00
Miss Islington (bot) 3e5bcd12f6
bpo-21196: Clarify name mangling rules in tutorial (GH-5667)
Initial patch by Chandan Kumar.
(cherry picked from commit 13ae4d4438)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
2018-10-19 17:41:56 -07:00
Miss Islington (bot) 2a6cf44680
bpo-33726, doc: Add short descriptions to PEP references in seealso (GH-7294)
(cherry picked from commit 0f14fc1a7c)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-10-19 16:43:55 -07:00
Miss Islington (bot) 76d31a3b96
queue doc: Clarify that the simple FIFO queue is SimpleQueue (GH-8372)
(cherry picked from commit acef69068f)

Co-authored-by: Julien Palard <julien@palard.fr>
2018-10-19 15:33:36 -07:00
Miss Islington (bot) 984a800e08
unittest.mock doc: Fix references to recursive seal of Mocks (GH-9028)
The docs in `library/unittest.mock` have been updated to remove
confusing terms about submock and be explicit about the behavior
expected.
(cherry picked from commit 96200eb2ff)

Co-authored-by: Mario Corchero <mariocj89@gmail.com>
2018-10-19 15:17:31 -07:00
Miss Islington (bot) 2bc1e8c909 In email docs, correct spelling of foregoing (GH-9856) (#9919)
(cherry picked from commit c984d20ec8)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-10-18 20:17:25 -04:00
Miss Islington (bot) 8ba831f847 In email.parser in message_from_bytes, update `strict` to `policy` (GH-9854) (#9917)
According to the versionchanged note, the `strict` argument was removed in 3.3 and `policy` was added, but the name of the argument in the paragraph wasn't updated.
(cherry picked from commit a5ca98537b)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-10-18 20:16:16 -04:00
Miss Islington (bot) 6802964fb4 Updated documentation on logging.debug(). (GH-9946) (GH-9949)
(cherry picked from commit bbd90e4f62)

Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2018-10-18 11:55:15 +01:00
Miss Islington (bot) 514bbfc7fc
bpo-34967: Sphinx is deprecating add_description_unit, use add_object_type (GH-9827)
(cherry picked from commit e385d0661e)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-10-15 23:46:38 -07:00
Miss Islington (bot) 802de12d99
bpo-23554: Change echo server example class name from EchoServerClientProtocol to EchoServerProtocol (GH-9859)
(cherry picked from commit 43a5bd7b45)

Co-authored-by: Braden Groom <braden.groom@gmail.com>
2018-10-15 14:59:49 -07:00
Cheryl Sabella b248a8c9a5 [3.7] bpo-11233: Create availability directive for documentation (GH-9692) (GH-9830)
Replace "Availability: xxx" with ".. availability:: xxx" in the doc.
 Original patch by Georg Brandl.

 Co-Authored-By: Georg Brandl <georg@python.org>
 (cherry picked from commit 2d6097d027)

 Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-10-15 22:52:26 +02:00
Miss Islington (bot) c804a5975d fix dangling keyfunc examples in documentation of heapq and sorted (GH-1432)
* fix dangling mention of key=str.lower in heapq doc

* Fix dangling mention of keyfunc example for sorted()
(cherry picked from commit 6bdb6f7675)

Co-authored-by: Wolfgang Maier <wolfgang.maier@biologie.uni-freiburg.de>
2018-10-15 13:19:08 -06:00