Commit Graph

9252 Commits

Author SHA1 Message Date
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) 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) 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
Miss Islington (bot) 9cdac5ced6
bpo-33319: Clarify subprocess call docs. (GH-12508)
Clarify capturing or suppressing stdout and stderr on the old call APIs.

Do not state that they are equivalent to run() calls when they are not implemented using run as that was misleading. Unlike run they cannot handle stdout or stderr being set to PIPE without a risk of deadlock.
(cherry picked from commit 7a2e84c348)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2019-03-23 00:46:15 -07:00
Miss Islington (bot) 868581ee76
bpo-35155: clarify protocol handler method naming (GH-10313)
Clarify that the naming of protocol handler methods shouldn't be literally called "protocol" but should be named after the actual protocol.

https://bugs.python.org/issue35155
(cherry picked from commit dd7c4ceed9)

Co-authored-by: Denton Liu <liu.denton+github@gmail.com>
2019-03-22 16:30:04 -07:00
Miss Islington (bot) bedfbc790e bpo-36321: Fix misspelled attribute in namedtuple() (GH-12375) (GH-12395)
(cherry picked from commit 23581c018f)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-03-18 00:48:02 -07:00
Mariatta 76ff715e03
Fix typo in unittest.mock documentation: manger -> manager (GH-12352)
(cherry picked from commit dc69f69f14)

Co-authored-by: Joan Massich <mailsik@gmail.com>
2019-03-17 16:53:06 -07:00
Miss Islington (bot) 68e0ed6a90
Update the seealso entries for namedtuple() (GH-12373)
* Replace external recipe link with a link to the dataclasses module.

* Highlight the class definition syntax for typing.NamedTuple
  and add an example for clarity.
(cherry picked from commit 9c68543f02)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-03-16 13:01:35 -07:00
Miss Islington (bot) e213cd6325
bpo-36138: Clarify docs about converting datetime.timedelta to scalars. (GH-12137)
Be explicit that timedelta division converts an overall duration to the interval
units given by the denominator.
(cherry picked from commit f40b4a0b62)

Co-authored-by: Yasser A <yalshalaan@gmail.com>
2019-03-15 21:03:43 -07:00
Miss Islington (bot) 2c177ec6c5
[3.7] Doc: Fix inconsistency in multiprocessing (GH-12273) (GH-12275)
(cherry picked from commit d9bd8ec2a4)


Co-authored-by: Julien Palard <julien@palard.fr>
2019-03-11 07:23:30 -07:00
Miss Islington (bot) 87f5255cdc
bpo-21314: Add a FAQ entry about positional only parameters (GH-10641)
(cherry picked from commit 1aeeaeb79e)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2019-03-10 04:36:18 -07:00
Miss Islington (bot) ae2378af3e
Fix padding on asyncio.IncompleteReadError docs (GH-12258)
(cherry picked from commit 11205b8030)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-03-10 04:12:12 -07:00
Steve Dower daad2c482c
bpo-36216: Add check for characters in netloc that normalize to separators (GH-12201) 2019-03-07 09:08:18 -08:00
Miss Islington (bot) bf44f48b63
Fix the documentation for set.copy() (GH-12176)
Remove 's' mention as there's no argument.
(cherry picked from commit e942e7b5c9)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-03-06 21:30:33 -08:00
Miss Islington (bot) bf35cc2593
Doc: Use `option` word for command line interface. (GH-12142)
For command line option, `option` is better than `parameter`.
(cherry picked from commit 0983fcd0d5)

Co-authored-by: NAKAMURA Osamu <osamu0329nakamura@users.noreply.github.com>
2019-03-04 20:49:47 -08:00
Miss Islington (bot) 3f1f9f0eee
Fixed a missing . and a missing capital letter. (GH-12170)
(cherry picked from commit 7e9ce4c89e)

Co-authored-by: Jules Lasne (jlasne) <jlasne@student.42.fr>
2019-03-04 11:41:31 -08:00
Cheryl Sabella 7dc322f8a5 [3.7] Add versionadded directives to ssl.minimum_version and ssl.maxi… (GH-12101)
…mum_version (GH-11894).

(cherry picked from commit ae2ea33d5d)

Co-authored-by: Zhiming Wang <i@zhimingwang.org>
2019-02-28 10:11:35 -08:00
Miss Islington (bot) 79e72591b1
Fix grammar error in timeit module docs (GH-12066)
skip issue
skip news
(cherry picked from commit 4064089fce)

Co-authored-by: Shiv Dhar <shivdhar@gmail.com>
2019-02-27 15:27:36 -08:00
Serhiy Storchaka 95fc8e687c
[3.7] bpo-28450: Fix and improve the documentation for unknown escapes in RE. (GH-11920). (GH-12029)
(cherry picked from commit a180b007d9)
2019-02-25 18:28:53 +02:00
Miss Islington (bot) 38aea4131f
bpo-24310: Document IDLE settings dialog font tab sample (GH-12007)
(cherry picked from commit d610116a2e)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2019-02-23 20:23:08 -08:00
Miss Islington (bot) 6163210089
bpo-36019: Use pythontest.net instead of example.com in network tests (GH-11941)
(cherry picked from commit a40681dd5d)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2019-02-22 06:03:26 -08:00
Julien Palard 22bfe637ca [3.7] Doc: Missing backquotes. (GH-11982) (GH-11985)
(cherry picked from commit 6e240ddd0d)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-02-22 00:56:06 -08:00
Miss Islington (bot) b046f1bada
bpo-28235: Fix xml.etree.ElementTree.fromstring docs (GH-11903)
(cherry picked from commit e5458bdb6a)

Co-authored-by: Manjusaka <lizheao940510@gmail.com>
2019-02-21 16:45:31 -08:00
Miss Islington (bot) 7121a6eeb7 bpo-36060: Document how collections.ChainMap() determines iteration order (GH-11969) (GH-11978)
(cherry picked from commit 86f093f71a)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-02-21 09:47:46 -08:00
Miss Islington (bot) 300605990d bpo-36059: Update OrderedDict() docs to reflect that regular dicts are now ordered (GH-11966) (GH-#11972)
(cherry picked from commit 49fd6dd887)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-02-21 00:18:51 -08:00
Miss Islington (bot) 92ac01b104
Doc: fix example for iter() function. (GH-11959)
read() returns bytes for a file opened in binary mode,
so b'' should be used as a sentinel instead of ''.
Otherwise the loop will be infinite.
(cherry picked from commit 11fa0e48a9)

Co-authored-by: Cristian Ciupitu <cristian.ciupitu@yahoo.com>
2019-02-20 23:59:28 -08:00
Miss Islington (bot) 14baf06feb bpo-31982: Improve sequence of presentation in ChainMap docs (GH-11960) (GH-11961)
https://bugs.python.org/issue31982
(cherry picked from commit 9b0c681e2d)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-02-20 14:23:29 -08:00
Miss Islington (bot) 0e379d43ac
bpo-34294: re module, fix wrong capturing groups in rare cases. (GH-11546)
Need to reset capturing groups between two SRE(match) callings in loops, this fixes wrong capturing groups in rare cases.

Also add a missing index in re.rst.
(cherry picked from commit 4a7f44a2ed)

Co-authored-by: animalize <animalize@users.noreply.github.com>
2019-02-18 05:48:23 -08:00
Miss Islington (bot) 7a3cbcdc55 Improve readability of random module examples (GH-11884) (GH-11885)
Based on reviewer feedback from Allen Downey, convert ``lambda`` to ``def``.
(cherry picked from commit 9abb725cea)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-02-15 12:47:04 -08:00
Miss Islington (bot) f6097306ff Fix the versionadded info for typing.NoReturn (GH-11880)
The earliest version that `typing.NoReturn` appears in is [3.5.4rc1](https://docs.python.org/3/whatsnew/changelog.htmlGH-python-3-5-4-release-candidate-1)
(cherry picked from commit 903567e4f5)

Co-authored-by: Jack Wilsdon <jack.wilsdon@gmail.com>
2019-02-15 11:31:28 -08:00
Miss Islington (bot) 05f41363d4
bpo-36006: Fix versionchanged directive alignment in io module documentation (GH-11881)
https://bugs.python.org/issue36006
(cherry picked from commit 522630a746)

Co-authored-by: Emmanuel Arias <emmanuelarias30@gmail.com>
2019-02-15 11:09:38 -08:00
Miss Islington (bot) b8bcec35e0
bpo-30410: Documentation of sys.stdin/out/err update to reflect change in 3.6 (GH-10264)
Documentation of sys.stdin/out/err update to reflect change in 3.6 on Windows to use UTF-8.

Wording by Eryk Sun and Paul Moore.

https://bugs.python.org/issue30410
(cherry picked from commit 5723263a3a)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2019-02-14 15:45:20 -08:00
Miss Islington (bot) 2259b5af3c
[3.7] bpo-22062: Updated docstring and documentation for pathlib (GH-8519) (GH-11817)
Original patch by Mike Short


https://bugs.python.org/issue22062
(cherry picked from commit 537b6caa56)


Co-authored-by: Eivind Teig <eivind.teig@gmail.com>


https://bugs.python.org/issue22062
2019-02-11 04:02:57 -08:00
Miss Islington (bot) 3fcfef357e
bpo-35833: Revise IDLE doc for control codes sent to Shell. (GH-11799)
Add  a code example block.
(cherry picked from commit 8a03ff2ff4)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2019-02-08 20:43:20 -08:00
Inada Naoki 21ab7744ae
bpo-20001: update pathlib landing image (GH-11304)
(cherry picked from commit cd90f6a369)
2019-02-05 19:39:42 +09:00
Miss Islington (bot) a2f4c40233 bpo-26256: Document algorithm speed for the Decimal module. (GH-4808) (#11736)
(cherry picked from commit 00e9c55d27)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2019-02-02 15:46:09 +01:00
Miss Islington (bot) 09b66e027b
doc: http: Fix enum name for status code 416 (GH-11689)
(cherry picked from commit d97daebfa6)

Co-authored-by: Phil Jones <philip.graham.jones@googlemail.com>
2019-01-31 02:15:29 -08:00
Inada Naoki 5901444972
bpo-35865: doc: Remove wrong note and directives (GH-11711)
*  note about random dict order
* Remove wrong versionchanged directive
2019-01-31 17:54:55 +09:00
Miss Islington (bot) 03082a836b
bpo-35854: Fix EnvBuilder and --symlinks in venv on Windows (GH-11700)
(cherry picked from commit a1f9a3332b)

Co-authored-by: Steve Dower <steve.dower@microsoft.com>
2019-01-30 14:14:35 -08:00
Miss Islington (bot) e31f8604e6 Document differences between random.choices() and random.choice(). (GH-11703) (GH-11706) 2019-01-30 13:49:23 -08:00
Miss Islington (bot) 7516f265a8
bpo-35835: Add reference to Python 3.7 new breakpoint() function in pdb documentation. (GH-11691)
(cherry picked from commit cf991e653a)

Co-authored-by: João Matos <jcrmatos@gmail.com>
2019-01-30 09:41:51 -08:00
Miss Islington (bot) ff27f8145d
Fix typo: class declaration (GH-11678)
(cherry picked from commit dfc8bb987d)

Co-authored-by: nu_no <nuno.an@gmail.com>
2019-01-27 14:25:49 -08:00
Miss Islington (bot) 658ff84496
Clarify U-mode deprecation in open() (GH-11646)
The previous wording could be read as saying that universal
newlines mode itself was deprecated, when it's only the 'U'
character in the mode field that should be avoided.

The update also moves the description of the 'U' mode character
out of the mode table, as the longer explanation was overly
intrusive as a table entry and overshadowed the actually useful
mode characters.
(cherry picked from commit 3171df3414)

Co-authored-by: Nick Coghlan <ncoghlan@gmail.com>
2019-01-27 08:27:58 -08:00
Miss Islington (bot) c2674bf110 bpo-34134: Advise to use imap or imap_unordered when handling long iterables. (gh-8324) (gh-11673)
(cherry picked from commit 3bab40db96)

Co-authored-by: Windson yang <wiwindson@outlook.com>
2019-01-25 13:08:14 +01:00
Miss Islington (bot) 552478bb10 bpo-35722: Updated the documentation for the 'disable_existing_loggers' parameter (GH-11525) (GH-11655)
(cherry picked from commit f0c743604f)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2019-01-23 07:21:32 +00:00
Miss Islington (bot) ebb08beb08
bpo-23156: Remove obsolete tix install directions (GH-11595)
Tix was deprecated in 3.6 and the doc is wrong.  New users should use ttk.
(cherry picked from commit cf27c06229)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2019-01-17 16:07:10 -08:00