Commit Graph

9128 Commits

Author SHA1 Message Date
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) 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) 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
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
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) 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) 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
Miss Islington (bot) 57038bcb24
bpo-34576 warn users on security for http.server (GH-9720)
It was proposed to add an warning for http.server regarding security
issues. The wording was provided at bpo-26005 by @orsenthil
(cherry picked from commit 1d26c72e6a)

Co-authored-by: Felipe Rodrigues <felipe@felipevr.com>
2018-10-10 20:55:34 -07:00
Miss Islington (bot) c59e75ccf0
bpo-34901: add isolated (-I) flag to sys.flags (GH-9708)
https://bugs.python.org/issue34901
(cherry picked from commit 656d52dbfd)

Co-authored-by: Danish Prakash <grafitykoncept@gmail.com>
2018-10-07 09:18:20 -07:00
Miss Islington (bot) 1a2189353f bpo-34334: Don't log traceback twice in QueueHandler (GH-9537) (GH-9581)
(cherry picked from commit d345bb4d9b)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-10-07 00:33:37 -04:00
Miss Islington (bot) 4322b8dd0f
Correct grammar mistake in re.rst. (GH-9745)
(cherry picked from commit 7dfbd49671)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-10-06 12:56:45 -07:00
Miss Islington (bot) 0991b9bb94 [3.7] bpo-34158: Documentation UTC offset update (GH-8377) (GH-9732)
* Documentation of UTC offset update
Since changes in the UTC offset that allows sub-minute offsets, the documentation needs update:

- "%z" format code documentation update
Karthikeyan Singaravelan commented on bugs.python.org:
Added as part of 018d353c1c and a fix regarding duplicate words for that part was added at bac2d5ba30.
Relevant format string at https://github.com/python/cpython/pull/2896/filesGH-diff-25e2d173c84057d069b7890450714eddR214.
Relevant test case with 6-digit string for microsecond : https://github.com/python/cpython/pull/2896/filesGH-diff-acc40bec51c7de832de3361db3edae52R309.
Table at https://docs.python.org/3.7/library/datetime.htmlGH-strftime-and-strptime-behavior could also be updated with microseconds being optional in the second column
%z | UTC offset in the form ±HHMM[SS] (empty string if the object is naive). | (empty), +0000, -0400, +1030

- isoformat documentation update
According to me, needs confirmation:
Relevant format string at https://github.com/python/cpython/pull/4699/filesGH-diff-25e2d173c84057d069b7890450714eddR176
Relevant test case at https://github.com/python/cpython/pull/4699/filesGH-diff-25e2d173c84057d069b7890450714edd

* From Martin Panter: some style improvment;
From @pganssle: using f for fractional part of seconds in all file.
(cherry picked from commit 92878829c3)

Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
2018-10-05 22:44:23 -04:00
Miss Islington (bot) 2fcaaaca52 [3.7] Make it clear that the msg argument to assertWarns/assertWarnsRegex/assertRaisesRegex is keyword-only. (GH-9680) (GH-9681)
A follow up to be4e5b8920.
(cherry picked from commit e006b39a40)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2018-10-05 22:39:47 -04:00
Miss Islington (bot) 414d58f745 Clarify that AsyncExitStack works with coroutine functions (GH-9405) (GH-9408)
The docs were ambiguous about whether you pass in a coroutine function
or a coroutine object, e.g. is it:

  aestack.push_async_exit(some_async_func)

or

  aestack.push_async_exit(some_async_func())

(It's the first one.)
(cherry picked from commit a3c88ef12c)

Co-authored-by: Nathaniel J. Smith <njs@pobox.com>
2018-10-05 22:29:17 -04:00
Miss Islington (bot) 29c40c7314 bpo-34825: Add more entries to os to pathlib reference table (GH-9608) (#9717)
The added functions are as below :

| os module     | Pathlib       |
| ------------- | ------------- |
| os.chmod   | Path.chmod  |
| os.mkdir  | Path.mkdir  |
| os.rename | Path.rename |
| os.replace | Path.replace |
| os.rmdir  | Path.rmdir |
| os.remove, os.unlink | Path.unlink |
| os.path.samefile | Path.samefile |

Thanks

https://bugs.python.org/issue34825
(cherry picked from commit 6f9c55d1c0)

Co-authored-by: Xtreak <tirkarthi@users.noreply.github.com>
2018-10-05 19:06:17 +03:00
Miss Islington (bot) b3c4a050b7
bpo-34906: Doc: Fix typos (GH-9712)
(cherry picked from commit 07fbbfde1b)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-10-05 07:35:18 -07:00
Miss Islington (bot) 484c899a5b
Make it clear that the msg argument to assertRaises is keyword-only. (GH-9670)
(cherry picked from commit be4e5b8920)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2018-10-01 22:32:01 -07:00
Miss Islington (bot) 27d7f93f63 bpo-31865: Fix a couple of typos in the html.unescape() docs. (GH-9663)
(cherry picked from commit 30534cc717)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2018-10-01 17:43:54 -07:00
Miss Islington (bot) 655608a111 bpo-34476: Document that asyncio.sleep() always suspends. (GH-9643) (#9654)
(cherry picked from commit cd602b8af2)

Co-authored-by: Hrvoje Nikšić <hniksic@gmail.com>
2018-10-01 13:19:33 +03:00
Miss Islington (bot) b0b8f9bd4e bpo-27351: Fix ConfigParser.read() documentation and docstring (GH-8123)
Switch "list" with "iterable" to match with the implementation.
(cherry picked from commit e45473e3ca)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2018-09-29 10:33:05 -06:00
Miss Islington (bot) 4c1b2ad44f
Fix astuple in dataclasses documentation (GH-9631)
(cherry picked from commit 508d820512)

Co-authored-by: 방성범 (Bang Seongbeom) <bangseongbeom@hotmail.com>
2018-09-29 03:55:14 -07:00
Miss Islington (bot) 85ccedc5b5
bpo-34802: Fix asyncio.iscoroutine() docs (GH-9611)
(cherry picked from commit 59ee5b1293)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-27 12:53:18 -07:00
Miss Islington (bot) 4ea64a25c2
Clarify that Type[SomeTypeVar] is legal (GH-9585)
Currently, the docs state that when doing `Type[X]`, X is only allowed to
be a class, a union of classes, and Any. This pull request amends
that sentence to clarify X may also be a typevar (or a union involving
classes, Any, and TypeVars).
(cherry picked from commit 130717fe58)

Co-authored-by: Michael Lee <michael.lee.0x2a@gmail.com>
2018-09-26 08:21:15 -07:00
Yury Selivanov 22a56958e7
[3.7] asyncio/docs: Replace Python 4.0 -> 3.10 (GH-9580) 2018-09-25 18:00:15 -04:00
Miss Islington (bot) 3cc9557d9f
bpo-34790: [docs] Passing coroutines to asyncio.wait() can be confusing. (GH-9543)
(cherry picked from commit 996859a90d)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-25 11:57:49 -07:00
Miss Islington (bot) bbdf872332
Fix wrong exception reference: BrokenThreadPool -> BrokenProcessPool (GH-9533)
(cherry picked from commit b60b4683f6)

Co-authored-by: Joni Kähärä <joni.kahara@gmail.com>
2018-09-24 20:35:46 -07:00