Commit Graph

21969 Commits

Author SHA1 Message Date
Miss Islington (bot) 36494a9491
bpo-37580: Fix typo in http.cookiejar documentation (GH-14731)
[bpo-37580](https://bugs.python.org/issue37580): Markup typo in http.cookiejar doc

https://bugs.python.org/issue37580
(cherry picked from commit b5bbb8a740)

Co-authored-by: Milan Oberkirch <milan.oberkirch@geops.de>
2019-07-13 03:23:10 -07:00
Miss Islington (bot) 184d06b354
Fix typo in re.escape documentation (GH-14722)
(cherry picked from commit fb6c1f8d3b)

Co-authored-by: Robert DiPietro <rdipietro@gmail.com>
2019-07-13 01:40:54 -07:00
Miss Islington (bot) 71435f685c
closes bpo-37554: Remove `q:q` in os.rst documentation (GH-14692)
https://bugs.python.org/issue37554
(cherry picked from commit 7cbef72902)

Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
2019-07-11 10:48:00 -07:00
Miss Islington (bot) d3747fd8fa bpo-34369: make kqueue.control() docs better reflect that timeout is positional-only (GH-9499)
(cherry picked from commit 79042ac434)

Co-authored-by: Tal Einat <taleinat@gmail.com>
2019-07-11 17:16:45 +03:00
Miss Islington (bot) 2847a75c21
Document default parameter of .seek() in the signature. (GH-14691)
(cherry picked from commit 2a3d4d9c53)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2019-07-10 19:49:37 -07:00
Miss Islington (bot) 8b1135fc60
Doc: Fix example title. (GH-14639)
(cherry picked from commit 66b4150f6f)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-07-08 14:18:15 -07:00
Miss Islington (bot) 6f5574866c
Doc: Fix: Proper UpperCamelCase and lowercase. (GH-14644)
Initial report by Michael Blankenship on docs@
(cherry picked from commit 2da622ff77)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-07-08 14:13:59 -07:00
Miss Islington (bot) bc0a6ced30
bpo-37513: Change ValueError to TypeError in an example in ctypes doc (GH-14615)
(cherry picked from commit f6cdd3ff68)

Co-authored-by: Hai Shi <shihai1992@gmail.com>
2019-07-07 08:45:59 -07:00
Miss Islington (bot) e841a54206
bpo-37478: Add missing 'and'. (GH-14631)
(cherry picked from commit a9b40e4546)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2019-07-06 19:49:39 -07:00
Miss Islington (bot) 1dd6507595 bpo-37478: Specify possible exceptions for os.chdir() (GH-14611) (GH-14630)
(cherry picked from commit 0717b4d9b3)

Co-authored-by: Kyle Stanley <aeros167@gmail.com>
2019-07-06 22:19:08 -04:00
Miss Islington (bot) 9c930d076a bpo-37487: Fix PyList_GetItem index description. (GH-14623) (GH-14625)
0 is a legal index.
(cherry picked from commit f8709e804d)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2019-07-06 17:55:19 -04:00
Miss Islington (bot) d666217b26
bpo-26806: add 30 to the recursion limit in IDLE's shell (GH-13944)
This is done to compensate for the extra stack frames added by
IDLE itself, which cause problems when setting the recursion limit
to low values.

This wraps sys.setrecursionlimit() and sys.getrecursionlimit()
as invisibly as possible.
(cherry picked from commit fcf1d003bf)

Co-authored-by: Tal Einat <taleinat+github@gmail.com>
2019-07-06 05:56:10 -07:00
Miss Islington (bot) d2c5677a4f
bpo-37149: Replace dead link for online Tkinter reference (GH-14616)
Also fix a name misspelling.
(cherry picked from commit 45bc61b971)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2019-07-05 23:37:38 -07:00
Miss Islington (bot) af5e62e9e2
closes bpo-37508: Fix name of type in memory.rst. (GH-14604)
(cherry picked from commit 39a5d17a7f)

Co-authored-by: Hai Shi <shihai1992@gmail.com>
2019-07-05 21:08:40 -07:00
Miss Islington (bot) d5a72923c2
Use OSError subclasses in os documentation (GH-14262)
(cherry picked from commit a55f75a6e3)

Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
2019-07-05 01:47:42 -07:00
Miss Islington (bot) d7d9c9f7c2 bpo-37459: importlib docs improperly reference get_resource_loader() (GH-14568) (GH-14581)
* bpo-37459: importlib docs improperly reference get_resource_loader()
(cherry picked from commit b607d992e7)

Co-authored-by: aldwinaldwin <aldwinaldwin@users.noreply.github.com>
2019-07-03 18:27:59 -07:00
Miss Islington (bot) 6323ac1dd4
bpo-37441: Fix wrong PyErr_SetImportErrorSubclass signature in doc (GH-14453)
(cherry picked from commit aeecf38066)

Co-authored-by: Hai Shi <shihai1992@gmail.com>
2019-07-02 19:02:57 -07:00
Miss Islington (bot) 844a9d64a4 bpo-37470: Document more clearly the error handling for QueueHandler.emit(). (GH-14532) (GH-14534)
(cherry picked from commit 0f4e813282)
2019-07-01 20:51:20 +01:00
Miss Islington (bot) b0ab95bbe7 bpo-37469: Document usability of SimpleQueue with QueueHandler and QueueListener. (GH-14521) (GH-14526)
(cherry picked from commit e6b64b756f)
2019-07-01 19:52:57 +01:00
Miss Islington (bot) 45c10da409
bpo-10945: Drop support for bdist_wininst on non-Windows systems (GH-14506)
bdist_wininst depends on MBCS codec, unavailable on non-Windows,
and bdist_wininst have not worked since at least Python 3.2, possibly
never on Python 3.

Here we document that bdist_wininst is only supported on Windows,
and we mark it unsupported otherwise to skip tests.

Distributors of Python 3 can now safely drop the bdist_wininst .exe files
without the need to skip bdist_wininst related tests.
(cherry picked from commit 72cd653c4e)

Co-authored-by: Miro Hrončok <miro@hroncok.cz>
2019-07-01 05:42:08 -07:00
Miss Islington (bot) 471d785dc7 bpo-32934: Clarified meaning of 'capacity' for BufferingHandler and MemoryHandler. (GH-14498) (GH-14508)
(cherry picked from commit 84de34e39e)
2019-07-01 13:11:37 +01:00
Miss Islington (bot) 6be91102f7
[3.7] bpo-37440: Enable TLS 1.3 post-handshake auth in http.client (GH-14448) (GH-14496)
Post-handshake authentication is required for conditional client cert authentication with TLS 1.3.


https://bugs.python.org/issue37440
(cherry picked from commit d1bd6e79da)


Co-authored-by: Christian Heimes <christian@python.org>


https://bugs.python.org/issue37440
2019-07-01 00:07:52 -07:00
Miss Islington (bot) e2e41cd114
bpo-30754: Document textwrap.dedent blank line behavior. (GH-14469)
* Added documentation for textwrap.dedent behavior.
* Remove an obsolete note about pre-2.5 behavior from the docstring.
(cherry picked from commit eb97b9211e)

Co-authored-by: tmblweed <tmblweed@users.noreply.github.com>
2019-06-29 21:38:11 -07:00
Miss Islington (bot) 99f2f85177
bpo-37432: Doc: Fix signature of PyObject_Del() (GH-14430)
(cherry picked from commit b4bee03087)

Co-authored-by: Hai Shi <shihai1992@gmail.com>
2019-06-28 02:16:30 -07:00
Steve Dower 7b8a449d19
Improve Windows commands in tutorial (GH-14401) 2019-06-26 10:00:58 -07:00
Steve Dower 2a99fd911e
bpo-4963: Fix for initialization and non-deterministic behavior issues in mimetypes (GH-14376) 2019-06-25 09:12:14 -07:00
Miss Islington (bot) 887e0576b8
Fix rst formatting for several links in ssl documentation (GH-13133)
(cherry picked from commit 7b3a028c35)

Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
2019-06-20 20:18:16 -07:00
Miss Islington (bot) 7b2a913bd8
Add missing single quote in io.TextIOWrapper.reconfigure documentation (GH-14246)
Add a missing single quote character in the documentation for `io.TextIOWrapper.reconfigure`.
(cherry picked from commit 35068bd059)

Co-authored-by: Harmon <Harmon758@gmail.com>
2019-06-19 14:07:45 -07:00
Miss Islington (bot) b64e42e931 bpo-37331: Clarify format of socket handler messages in the documentation. (GH-14234) (GH-14236)
(cherry picked from commit f06b569305)
2019-06-19 15:41:54 +01:00
Miss Islington (bot) 9eb4b2c8a3 bpo-37258: Not a bug, but added a unit test and updated documentation. (GH-14229) (GH-14231)
(cherry picked from commit 0150001653)
2019-06-19 14:46:19 +01:00
Ivan Levkivskyi d0587353fe [3.7] bpo-36985: Document typing.ForwardRef (GH-14216) (GH-14220)
https://bugs.python.org/issue36985
2019-06-18 18:02:15 -07:00
Miss Islington (bot) 452b417e34
bpo-34903: Document that some strptime formats only require 1 digit (GH-14149)
For datetime.datetime.strptime(), the leading zero for some two-digit formats is optional.

This adds a footnote to the strftime/strptime documentation to reflect this fact, and adds some tests to ensure that it is true.

bpo-34903
(cherry picked from commit 6b9c204ee7)

Co-authored-by: Mike Gleen <mike.gleen@gmail.com>
2019-06-18 11:55:27 -07:00
Miss Islington (bot) 81f7899f51
bpo-5680: IDLE: Customize running a module (GH-13763)
The initialize options are 1) add command line options, which are appended to sys.argv as if passed on a real command line, and 2) skip the shell restart. The customization dialog is accessed by a new entry on the Run menu.
(cherry picked from commit 201bc2d18b)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2019-06-17 19:47:55 -07:00
Miss Islington (bot) 0f31a2d3e8
bpo-37039: Make IDLE's Zoom Height adjust to users' screens (GH-13678)
Measure required height by quickly maximizing once per screen.
A search for a better method failed.
(cherry picked from commit 5bff3c86ab)

Co-authored-by: Tal Einat <taleinat+github@gmail.com>
2019-06-17 13:06:39 -07:00
Victor Stinner ac4202ee4d
bpo-37194: Complete PyObject_CallXXX() docs (GH-14156) (GH-14158)
Mention explicitly that PyObject_CallXXX() functions raise an
exception an failure.

(cherry picked from commit 1ce2656f13)
2019-06-17 15:23:52 +02:00
Miss Islington (bot) b101fa7783
bpo-28805: document METH_FASTCALL (GH-14079)
(cherry picked from commit 5600b5e1b2)

Co-authored-by: Jeroen Demeyer <J.Demeyer@UGent.be>
2019-06-16 16:24:06 -07:00
Miss Islington (bot) c289588905
Doc: Remove an ugly space before a dot. (GH-14123)
(cherry picked from commit 552951563c)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-06-16 07:37:02 -07:00
Julien Palard 159ae24895 [3.7] Doc: Add an optional obsolete header. (GH-13638). (GH-13655)
* [3.7] Doc: Add an optional obsolete header. (GH-13638).
(cherry picked from commit 46ed90dd01)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-06-15 14:27:10 -04:00
Miss Islington (bot) 30cac20101
Update weakref.rst (GH-14098)
(cherry picked from commit f475729a71)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2019-06-15 04:50:11 -07:00
Miss Islington (bot) 0bd1469a90
Update concurrent.futures.rst (GH-14061)
This PR adds missing details in the [`concurrent.futures`](https://docs.python.org/3/library/concurrent.futures.html) documentation:

* the mention that `Future.cancel` also returns `False` if the call finished running;
* the mention of the states for `Future` that did not complete: pending or running.
(cherry picked from commit 431478d5d7)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2019-06-14 07:52:14 -07:00
Miss Islington (bot) f0cc1a91f7
bpo-32625: Updated documentation for EXTENDED_ARG. (GH-13985)
Python 3.6 changed the size of bytecode instruction, while the documentation for `EXTENDED_ARG` was not updated accordingly.
(cherry picked from commit 405f648db7)

Co-authored-by: Yao Zuo <laike9m@users.noreply.github.com>
2019-06-11 20:51:42 -07:00
Makdon c59b1bbbb3 [3.7] bpo-37216: Fix version and filename in Mac using document (GH-13963) 2019-06-11 01:38:25 -04:00
Miss Islington (bot) 3621bf20e9
Stop using deprecated logging API in Sphinx suspicious checker (GH-9875)
(cherry picked from commit ee171a26c1)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2019-06-08 17:53:20 -07:00
Zackery Spytz e36ed475ea [3.7] bpo-37170: Fix the cast on error in PyLong_AsUnsignedLongLongMask() (GH-13860) (GH-13896)
(cherry picked from commit dc2476500d)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2019-06-07 17:41:10 +02:00
Miss Islington (bot) beba8c7fd3
Doc: Python 3.9 in sidebar and version switcher. (GH-13824)
(cherry picked from commit 59e7bbcaa4)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-06-04 16:21:34 -07:00
Miss Islington (bot) 12c178799a
bpo-30699: Improve example on datetime tzinfo instances (GH-4290)
* Improve example on tzinfo instances

Move from GMTX to TZX when naming the classes, as GMT1 might be rather
confusing as seen in the reported issue.
In addition, move to UTC over GMT and improve the tzname implementation.

* Simplify datetime with tzinfo example

Move the example in the documentation to just use timezone.utc and a
user defined Kabul timezone rather than having two user defined
timezones with DST.

Kabul timezone is still interesting as it changes its offset but not
based on DST. This is more accurate as the previous example was missing
information about the fold attribute. Additionally, implementing the fold
attribute was rather complex and probably not relevant enough for the
section "datetime with tzinfo".
(cherry picked from commit f0b5ae4567)

Co-authored-by: Mario Corchero <mcorcherojim@bloomberg.net>
2019-06-04 08:25:16 -07:00
Miss Islington (bot) cad4ff65eb
bpo-36868: Fix what's new for SSLContext.hostname_checks_common_name (GH-13248)
What's new now mentions SSLContext.hostname_checks_common_name instead of SSLContext.host_flags.

https://bugs.python.org/issue36868
(cherry picked from commit 47eb223406)

Co-authored-by: Christian Heimes <christian@python.org>
2019-06-03 12:02:11 -07:00
Miss Islington (bot) 15bde92e47
Doc fix: duplicate object description of email.message (GH-13742)
(cherry picked from commit 141da44bb4)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-06-03 08:25:52 -07:00
Miss Islington (bot) 9390e98c3e bpo-19184: Update the documentation of dis module. (GH-13652) (GH-13755)
* bpo-19184: Update the documentation of dis module

* Explain the behavior of the number of arguments of RAISE_VARGARGS
  opcode.

* bpo-19184: Update blurb.

* bpo-19184: Fix typo in the dis Documentation.

* bpo-19184: Address review comments and improve the doc

* bpo-19184: Remove news file.
(cherry picked from commit e1179a5096)

Co-authored-by: Michele Angrisano <michele.angrisano@gmail.com>
2019-06-03 01:18:50 +02:00
Miss Islington (bot) 6bd438e137 bpo-37014: Update docstring and Documentation of fileinput.FileInput(). (GH-13545) (GH-13753)
* bpo-37014: Update docstring and Documentation of fileinput.FileInput()

* Explain the behavior of fileinput.FileInput() when reading stdin.

* Update blurb.

* bpo-37014: Fix typo in the docstring and documentation.
(cherry picked from commit aca273e240)

Co-authored-by: Michele Angrisano <michele.angrisano@gmail.com>
2019-06-02 23:36:34 +02:00
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
Miss Islington (bot) 146010ea42
bpo-36783: Added C API Documentation for Time_FromTimeAndFold and PyDateTime_FromDateAndTimeAndFold (GH-13147)
(cherry picked from commit 5765ecf79f)

Co-authored-by: Edison A <20975616+SimiCode@users.noreply.github.com>
2019-05-07 08:17:50 -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) 88a2074e3b
[3.7] Clarify the download unit in the download section (GH-13122) (GH-13130)
(cherry picked from commit e9b49d1b4e)


Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2019-05-06 12:32:52 -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) 8777915ade
bpo-30668: add missing word in license.rst (GH-13115)
(cherry picked from commit 4920c093da)

Co-authored-by: Patrick Mühlbauer <tmuxbiene@googlemail.com>
2019-05-06 12:08:10 -07:00
Miss Islington (bot) 2b5ffc02c0 bpo-36189: Fixing typo in tutorial introduction (GH-13093)
(cherry picked from commit 98a1e06c47)

Co-authored-by: Jonatan <jonyucra@gmail.com>
2019-05-04 23:22:34 -04:00
Miss Islington (bot) 37125ff6e2 bpo-36166: Change to rst datamodel file. (GH-13089) (#13094)
(cherry picked from commit 5e98f05e55)

Co-authored-by: Catherine Alvarado <catherine@qventus.com>
2019-05-04 23:21:28 -04:00
Miss Islington (bot) 4b5340bb63
closes bpo-35329: Change 'Package' to 'package' in accordance with PEP8. (GH-13008)
(cherry picked from commit ee0309f3d8)

Co-authored-by: Utkarsh Gupta <guptautkarsh2102@gmail.com>
2019-04-29 19:26:00 -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) 4d0233ec65 bpo-30840: Document relative imports (GH-12831) (GH-12938)
* Document relative imports
(cherry picked from commit 70bf713617)

Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
2019-04-25 01:44:19 +10: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) 8c49d71385
Doc: add the missing ".tp_flags" in type definition (GH-12902)
(cherry picked from commit 662ebd2ab2)

Co-authored-by: Wu Wei <weiwu@cacheme.net>
2019-04-22 04:14:25 -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
Pablo Galindo 7723d0545c
[3.7] bpo-36427: Document that PyEval_RestoreThread and PyGILState_Ensure can terminate the calling thread (GH-12541) (GH-12820)
Calling these function from a thread when the runtime is finalizing will terminate
the thread, even if the thread was not created by Python. Users can use
_Py_IsFinalizing or sys.is_finalizing to check if the interpreter is in the process of
being finalized before calling this function to avoid unwanted termination.
(cherry picked from commit fde9b33)
2019-04-14 03:49:17 +01:00
Miss Islington (bot) be63df287a
Doc: define PY_SSIZE_T_CLEAN always (GH-12794)
(cherry picked from commit c88feceb44)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2019-04-12 18:56:50 -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) 395bb94a7f
bpo-33922: Adding documentation for new "-64" suffix of Python launcher (GH-7849)
Since bpo-30291 it is possible to specify the architecture of Python when using the launcher
(cherry picked from commit 1e2ad6c275)

Co-authored-by: mrh1997 <mrh1997@users.noreply.github.com>
2019-04-12 15:32:33 -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
Victor Stinner 9e23f0a27c
[3.7] bpo-36389: _PyObject_IsFreed() now also detects uninitialized memory (GH-12770) (GH-12788)
* bpo-36389: _PyObject_IsFreed() now also detects uninitialized memory (GH-12770)

Replace _PyMem_IsFreed() function with _PyMem_IsPtrFreed() inline
function. The function is now way more efficient, it became a simple
comparison on integers, rather than a short loop. It detects also
uninitialized bytes and "forbidden bytes" filled by debug hooks
on memory allocators.

Add unit tests on _PyObject_IsFreed().

(cherry picked from commit 2b00db6855)

* bpo-36389: Change PyMem_SetupDebugHooks() constants (GH-12782)

Modify CLEANBYTE, DEADDYTE and FORBIDDENBYTE constants: use 0xCD,
0xDD and 0xFD, rather than 0xCB, 0xBB and 0xFB, to use the same byte
patterns than Windows CRT debug malloc() and free().

(cherry picked from commit 4c409beb4c)
2019-04-11 22:30:31 +02: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) 59fd08c25c
better __init__.py explanation in tutorial (GH-12763)
* better __init__.py explanation in tutorial

* Update Doc/tutorial/modules.rst

Co-Authored-By: methane <songofacandy@gmail.com>
(cherry picked from commit 5410d3d283)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2019-04-10 23:16:34 -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
Miss Islington (bot) 1f0ff57acb
Correct "inplace" with "in-place" (GH-10480)
(cherry picked from commit f4efa312d1)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-04-08 02:21:38 -07:00
Miss Islington (bot) a9a065addd
bpo-9883: Update list of unimplemented interfaces in minidom. (GH-12677)
Remove names from the "unimplemented interfaces" list
in the minidom docs that are actually implemented.
(cherry picked from commit 2ea8099523)

Co-authored-by: Stefan Behnel <stefan_ml@behnel.de>
2019-04-07 19:55:58 -07:00
Miss Islington (bot) 1bc6cd7066
Fix doc for create_subprocess_exec (GH-12598)
Add missing `program` argument to asyncio.create_subprocess_exec documentation.
(cherry picked from commit 1328375ad1)

Co-authored-by: Dima Tisnek <dimaqq@gmail.com>
2019-04-05 07:08:31 -07:00
Miss Islington (bot) 86fbe0287d
bpo-36404: recommend DeprecationWarning over PendingDeprecationWarning (GH-12505)
(cherry picked from commit 176d26364b)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2019-04-05 02:07:21 -07:00
Miss Islington (bot) ef516d11c1
bpo-32413: Add documentation that at the module level, locals(), globals() are the same dictionary (GH-5004)
https://bugs.python.org/issue32413
(cherry picked from commit 1c5fa5af8a)

Co-authored-by: Srinivas Reddy Thatiparthy (శ్రీనివాస్  రెడ్డి తాటిపర్తి) <thatiparthysreenivas@gmail.com>
2019-04-02 11:14:50 -07:00
Miss Islington (bot) 9a838c593f
bpo-35838: document optionxform must be idempotent (GH-12656)
(cherry picked from commit 04694a306b)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2019-04-02 02:29:16 -07:00
Miss Islington (bot) 35fc38e5e8
bpo-36157:Document PyInterpreterState_Main() (GH-12238)
I have added documentation for `PyInterpreterState_Main()`.
 I chose to place it under Advanced Debugger Support together with similar functions like `PyInterpreterState_Head()`, `PyInterpreterState_Next(`), and `PyInterpreterState_ThreadHead()` .

https://bugs.python.org/issue36157
(cherry picked from commit 8c61739def)

Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
2019-04-01 08:15:10 -07:00
Inada Naoki 8384670615
bpo-20844: open script file with "rb" mode (GH-12616)
(cherry picked from commit 10654c19b5)
2019-04-01 21:02:51 +09:00
Miss Islington (bot) 128e40f06f
C API docs: Py_IsInitialized is always safe to call (GH-12630)
(cherry picked from commit ddbb978e10)

Co-authored-by: Nick Coghlan <ncoghlan@gmail.com>
2019-03-30 04:29:43 -07:00
Miss Islington (bot) 5b80cb5584
bpo-17110: doc: add note how to get bytes from sys.argv (GH-12602)
(cherry picked from commit 38f4e468d4)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2019-03-29 22:38:14 -07:00
Miss Islington (bot) 40ee9a3640
Fixed capital letters missing and missing . (GH-12584)
No `bpo` for minor doc fix
(cherry picked from commit 3d78c4a6e5)

Co-authored-by: Jules Lasne (jlasne) <jlasne@student.42.fr>
2019-03-28 19:11:06 -07:00
Miss Islington (bot) 1d9f1a0c96
bpo-36425: Add Simplified Chinese to the language switcher (GH-12537)
(cherry picked from commit 45a5fdb91c)

Co-authored-by: zhsj <zsj950618@gmail.com>
2019-03-28 11:12:39 -07:00
Miss Islington (bot) 101ddba62d
Doc: Fixed missing punctuation in datamodel.rst (GH-12581)
(cherry picked from commit 1fc5bf2ff2)

Co-authored-by: Jules Lasne (jlasne) <jlasne@student.42.fr>
2019-03-27 03:18:36 -07:00
Miss Islington (bot) ead1579598
bpo-33832: Add "magic method" glossary entry (GH-7630)
(cherry picked from commit f760610bdd)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-03-26 18:26:52 -07:00
Miss Islington (bot) e16599c48c
Minor doc improvement (GH-10341)
Change "star-operator" to "* operator".
(cherry picked from commit dfd775a0b1)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-03-26 18:23:54 -07:00
Miss Islington (bot) 5ac626350e
bpo-34203: FAQ: improve wording of paragraph about 2.x vs. 3.x (GH-9821)
(cherry picked from commit 6cd658b1a5)

Co-authored-by: Tal Einat <taleinat+github@gmail.com>
2019-03-26 14:20:29 -07:00
Miss Islington (bot) eb94e5b3ec
Fix "the the" in the idle docs. (GH-12549)
(cherry picked from commit 577277f669)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2019-03-25 21:52:39 -07:00
Miss Islington (bot) b23b08623a
bpo-34085: Improve wording on classmethod/staticmethod (GH-8228)
* bpo-34085: Improve wording on classmethod/staticmethod

* Address comments from Éric

* Address comments from Éric
(cherry picked from commit 548cb6060a)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-03-25 16:00:00 -07:00
Miss Islington (bot) f3c5535f63 Add note to Queue.get() docs about block=True (GH-2223) (GH-12538)
(cherry picked from commit 713a8ae792)

Co-authored-by: Stephen Rosen <sirosen@globus.org>
2019-03-25 13:03:16 -07:00
Miss Islington (bot) fc00102363
bpo-31822: Document that urllib.parse.{Defrag,Split,Parse}Result are namedtuples (GH-4434)
(cherry picked from commit 13c1f72cd1)

Co-authored-by: Lisa Roach <lisaroach14@gmail.com>
2019-03-24 14:56:27 -07:00