Commit Graph

9349 Commits

Author SHA1 Message Date
Miss Islington (bot) 913210d13b
[3.7] Touch up venv docs (GH-14922) (GH-14924)
(cherry picked from commit 2f224a077a)


Co-authored-by: Brett Cannon <54418+brettcannon@users.noreply.github.com>

Automerge-Triggered-By: @brettcannon
2019-07-24 10:14:35 -07:00
Tal Einat e9ec1663d8
[3.7] bpo-17535: IDLE editor line numbers (GH-14030)
(cherry picked from commit 7123ea009b)
2019-07-23 16:27:04 +03:00
Kyle Stanley 83cec020ba [3.7] Fix typos in docs, comments and test assert messages (GH-14872). (#14901)
(cherry picked from commit 96e12d5f4f)

Co-authored-by: Min ho Kim <minho42@gmail.com>
2019-07-22 14:14:07 -04:00
Miss Islington (bot) 134f79682d
bpo-37284: Add note to sys.implementation doc (GH-14328)
Add a brief note to indicate that any new required attributes must go through the PEP process.

https://bugs.python.org/issue37284
(cherry picked from commit 52693c10e8)

Co-authored-by: Giovanni Cappellotto <gcappellotto@fb.com>
2019-07-15 07:44:26 -07:00
Miss Islington (bot) 13c89f3c87
bpo-37571: Remove extra space in ctypes docs (GH14764)
(cherry picked from commit 68c74d05c1)

Co-authored-by: Steve Dower <steve.dower@python.org>
2019-07-14 01:24:35 -07:00
Miss Islington (bot) d7caf75c73
bpo-37571: Add 'b' to prevent the TypeError exception. (GH-14721)
Co-Authored-By: Kyle Stanley <aeros167@gmail.com>
(cherry picked from commit 6b929580eb)

Co-authored-by: Michele Angrisano <michele.angrisano@gmail.com>
2019-07-14 01:08:48 -07:00
Miss Islington (bot) d1524148cd
bpo-30088: Document that existing dir structure isn't verified by mailbox.Maildir (GH-1163)
Hi,

I've faced an issue w/ `mailbox.Maildir()`. The case is following:
1. I create a folder with `tempfile.TemporaryDirectory()`, so it's empty
2. I pass that folder path as an argument when instantiating `mailbox.Maildir()`
3. Then I receive an exception happening because "there's no such file or directory" (namely `cur`, `tmp` or `new`) during interaction with Maildir

**Expected result:** subdirs are created during `Maildir()` instance creation.

**Actual result:** subdirs are assumed as existing which leads to exceptions during use.

**Workaround:** remove the actual dir before passing the path to `Maildir()`. It will be created automatically with all subdirs needed.

**Fix:** This PR. Basically it adds creation of subdirs regardless of whether the base dir existed before.

https://bugs.python.org/issue30088
(cherry picked from commit e44184749c)

Co-authored-by: Sviatoslav Sydorenko <wk@sydorenko.org.ua>
2019-07-13 07:59:32 -07:00
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) 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) 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) 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) 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) 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
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
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
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) 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) 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