Commit Graph

20368 Commits

Author SHA1 Message Date
Stéphane Wirtel ad65d09fd0 [2.7] bpo-33503: Fix the broken pypi link in the source and the documentation (GH-6814). (GH-6905)
(cherry picked from commit 19177fbd5d)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-05-16 10:57:36 -04:00
Miss Islington (bot) 84fc6c59cf
bpo-22069: Update TextIO documentation (GH-6609)
Clarify that flush is implied when the call to write contains a newline character.
(cherry picked from commit 7ffd4c58fa)

Co-authored-by: Elena Oat <oat.elena@gmail.com>
2018-05-14 09:11:42 -07:00
Serhiy Storchaka d7e783b17f
[2.7] bpo-13525: Fix incorrect encoding name in the tutorial example. (GH-6738). (GH-6744)
(cherry picked from commit ddb6215a55)
2018-05-09 12:35:28 +03:00
Bo Bayles 4a1bc26832 [2.7] bpo-32362: Fix references to non-existent multiprocessing.Connection() (GH-6223) (GH-6646)
(cherry picked from commit 9f3535c9cd)

Co-authored-by: Bo Bayles <bbayles@gmail.com>
2018-05-05 14:09:46 +03:00
Bo Bayles 07c3a612c7 Fix reference to exceptions in multprocessing docs. (GH-6647) 2018-04-30 08:29:24 +03:00
Andrés Delfino 1c6c8510f9 [2.7] bpo-33280: Reorganize external Tcl/Tk references. (GH-6473). (GH-6607)
(cherry picked from commit 67a8f4fed3)

Co-authored-by: Andrés Delfino <34587441+andresdelfino@users.noreply.github.com>
2018-04-26 16:50:07 +03:00
Andrés Delfino b9827b7620 [2.7] bpo-33297: Mention Pillow to work with more image formats. (GH-6505) (GH-6562)
Also update PIL doc references to Pillow.
(cherry picked from commit 'b81ca28b378c8b29204a37f8bd433a3379f53f7d')

Co-authored-by: 'Andrés Delfino.34587441+andresdelfino@users.noreply.github.com'
2018-04-21 19:06:40 +03:00
Andrés Delfino 7a45eb9efb bpo-33283: Mention PNG as a supported format by Tcl/Tk. (GH-6479) (GH-6542)
(cherry picked from commit 4b685bf719)

Update only the documentation about image formats.
2018-04-20 09:15:01 +03:00
Benjamin Peterson 7d19676213
[2.7] fix pydoc-topics to work with Sphinx 1.7 (GH-6502)
In fact, we now require a newer Sphinx version because APIs have moved around..
(cherry picked from commit acfb087f9f)
2018-04-16 23:54:08 -07:00
Miss Islington (bot) 77f0a41d72 [2.7] bpo-8243: Doc patch for curses.window.addstr and curses.window.addch (GH-5179) (GH-6405)
(cherry picked from commit ef5ce884a4)

Co-authored-by: Jay Crotts <crotts.jay@gmail.com>
2018-04-06 22:01:35 -04:00
Cheryl Sabella 325191bd6b [2.7] bpo-27212: Modify islice recipe to consume initial values preceding start (GH-6195) (GH-6339)
(cherry picked from commit da1734c58d)
2018-04-01 22:29:01 -07:00
Miss Islington (bot) a2665075cc
Fix description about SimpleXMLRPCServer constructor parameter bind_and_activate. (GH-776)
Passing True as the `bind_and_activate` *do* immediately opening and binding to their socket.
(cherry picked from commit e6223579c8)

Co-authored-by: cocoatomo <cocoatomo77@gmail.com>
2018-03-26 05:11:15 -07:00
Brett Cannon 20003f9162
bpo-32963: Fix the tutorial to state source has a default encoding of ASCII (GH-5961) 2018-03-02 14:10:21 -08:00
Miss Islington (bot) ecaa372f74
bpo-32500: Correct the documentation for PySequence_Size() and PySequence_Length() (GH-5767)
Dropped the part that says: "For objects that do not provide sequence protocol".
(cherry picked from commit 7a1e1786f9)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2018-02-25 13:22:43 -08:00
Cheryl Sabella b7c1a94f94 [2.7] bpo-25059: Clarify the print separator usage in tutorial (GH-5879)
By default `print` adds spaces between its arguments.

(cherry picked from commit 84c4b0cc67)
2018-02-25 12:50:26 -08:00
Miss Islington (bot) 76349471ad
bpo-31454: Include information about "import X as Y" in Modules tutorial (GH-4041)
(cherry picked from commit fbee88244e)

Co-authored-by: Mario Corchero <mariocj89@gmail.com>
2018-02-25 11:38:24 -08:00
Christian Heimes 3d87f4cf9c
[2.7] bpo-30622: Improve NPN support detection (GH-5859) (#5863)
The ssl module now detects missing NPN support in LibreSSL.

Co-Authored-By: Bernard Spil <brnrd@FreeBSD.org>
Signed-off-by: Christian Heimes <christian@python.org>.
(cherry picked from commit 6cdb7954b0)

Co-authored-by: Christian Heimes <christian@python.org>
2018-02-25 10:21:03 +01:00
Miss Islington (bot) 8a7f1f4b0f
bpo-32923: Unittest doc: replace `whilst` with `while` (GH-5833)
`whilst` and `while` are both english words, `whilst` is not as commonly used.
This can be confusing to readers whose primary language is not english.
(cherry picked from commit 98f42aac23)

Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
2018-02-23 10:16:56 -08:00
Benjamin Peterson 6c7edba166
[2.7] closes bpo-32008: don't use PROTOCOL_TLSv1 in example (GH-5789) (#5792)
It's bad form to pin to an old version of TLS. ssl.SSLContext has the right
protocol default, so let's not pass anyway..
(cherry picked from commit e9edee0b65)
2018-02-20 22:17:10 -08:00
Raymond Hettinger 5dc275a2c0
Fix typo in docs (GH-5763) 2018-02-19 15:39:20 -08:00
Miss Islington (bot) fd9d1c901d
DOC: fix documentation for copyright and credits (GH-5706)
Adapt documentation for `copyright` and `credits` to reality.  Previously, the documentation implied that all each of `copyright`,
`credits`, and `license`, would print a message to call the object in order to see the full text.  In reality, only `license` exhibits this
behaviour, and `copyright` and `credit` print their full text either when printed, displayed, or called.
(cherry picked from commit 243d6d7126)

Co-authored-by: Gerrit Holl <gerrit.holl@gmail.com>
2018-02-16 20:11:48 -08:00
Miss Islington (bot) 877112567a
Fix installation instructions for *nix (GH-5605)
Remove pkg_add -r python from FreeBSD installation section.
Moved to OpenBSD.
(cherry picked from commit 3384d38d51)

Co-authored-by: Eitan Adler <grimreaper@users.noreply.github.com>
2018-02-13 19:55:09 -08:00
Miss Islington (bot) ea6e6444bd bpo-32800: Update link to w3c doc for xml default namespaces (GH-5609) (GH-5613)
The new link is given in a red box on the old page.
(cherry picked from commit 8d1f2f4038)

Co-authored-by: sblondon <sblondon@users.noreply.github.com>
2018-02-10 19:42:42 -05:00
Stéphane Wirtel 672fd7d816 bpo-32784: Wrong argument name for csv.DictReader in documentation (GH-5575)
Use `f` as the name of the first parameter of `csv.DictReader` and
`csv.DictWriter` classes.
2018-02-07 08:05:35 -08:00
Raymond Hettinger 2a4e2ea112
Fix typo -- missing "not" (GH-5532) 2018-02-04 10:34:29 -08:00
Raymond Hettinger 42e8ea9f69
bpo-32739: Show default value for rotate() (GH-5517)
Manual backport of GH-5485
2018-02-03 13:57:02 -08:00
Ned Deily 2357cd71b0 Update Doc build for split off of 3.7 branch 2018-02-03 16:31:41 -05:00
Bo Bayles f5a793522d bpo-32304: Fix distutils upload for tar files ending with b'\r' (GH-5264) (GH-5331)
Patch by Bo Bayles.
2018-01-29 09:31:32 -05:00
Miss Islington (bot) 5679277fdd Fix PyTrace_RETURN documentation (GH-5384) (GH-5387)
It will be triggered when propagating an exception.
(cherry picked from commit 79db11ce99)
2018-01-28 23:49:14 +08:00
Miss Islington (bot) 745e9de7dd bpo-32687: Fix wrong meaning of args for PyTrace_LINE/CALL in documentation (GH-5361) (GH-5378)
(cherry picked from commit 9ed0aee27c)
2018-01-28 16:41:29 +08:00
Mariatta f5e8f71fe3
[2.7] bpo-32640: Clarify the behavior of str.join and unicode object (GH-5333)
In str.join, if any of the iterable contains a Unicode object,
str.join will return a Unicode object.

A Type error will be raised if iterable contains values other
than a string or Unicode object.
2018-01-26 09:55:15 -08:00
Xiang Zhang e64a47b37d
bpo-17799: Explain real behaviour of sys.settrace and sys.setprofile (GH-4056). (#5299)
(cherry picked from commit 131fd7f96c)
2018-01-24 22:53:42 +08:00
Pablo Galindo 8ca036d471 bpo-32586: Fix code example in urllib2's doc (GH-5238)
It should be `urllib2.URLError` instead of just `URLError`.
2018-01-18 16:16:13 -08:00
Benjamin Peterson e13698172f
[2.7] advance copyright years to 2018 (GH-5094). (#5105)
(cherry picked from commit 65f2a6dcc2)
2018-01-04 23:02:11 -08:00
Serhiy Storchaka ca54740f25
[2.7] bpo-32211: Document the existing bug in re.findall() and re.finditer(). (GH-4695). (#5096)
(cherry picked from commit 1e6d8525f9)
2018-01-04 14:08:27 +02:00
Miss Islington (bot) 0e0d1017a4 bpo-32452: clarify term 'brackets' in generator tutorial (GH-5079) (#5082)
Updates documentation for generator expressions in classes tutorial: Clarify usage of ambiguous term "brackets" by replacing with "square brackets". Updated subsequent lines to respect line breaks. (GH-5079)
(cherry picked from commit f190eb59e6)
2018-01-02 10:42:12 -05:00
Miss Islington (bot) 3ff488c082 trivial: link updates in documentation (GH-2765) (#4836)
(cherry picked from commit 4f29f3c84b)
2017-12-13 14:45:13 +02:00
Vinay Sajip 292fce9934
bpo-32212: Updated logging documentation to make parameter names more consistent with source. (GH-4765) (GH-4768)
(cherry picked from commit a9f8df646a)
2017-12-09 12:49:10 +00:00
Mariatta 12fa6b1e2f
Add a missing space in tkinter documentation. (GH-4692). (GH-4723)
(cherry picked from commit ae342cf7de)
2017-12-04 21:15:57 -08:00
Miss Islington (bot) d6c6e586b4 Improve Scheduler Objects documentation. (GH-4556) (GH-4558)
Mention that the lower the priority number, the higher priority it represents.
(cherry picked from commit 9d5ec808de)
2017-11-24 21:49:10 -08:00
Miss Islington (bot) c02037d622 bpo-30004: Fix the code example of using group in Regex Howto Docs (GH-4443) (GH-4555)
The provided code example was supposed to find repeated words, however it returned false results.
(cherry picked from commit 610e5afdcb)
2017-11-24 21:01:39 -08:00
Miss Islington (bot) 465f3d0820 Improve the String tutorial docs (GH-4541) (GH-4546)
The paragraph that contains example of string literal concatenation was placed
after the section about concatenation using the '+' sign.
Moved the paragraph to the appropriate section.
(cherry picked from commit 78a5722ae9)
2017-11-24 09:35:53 -08:00
Miss Islington (bot) 66cdc84e40 Extending Python Doc minor updates (GH-4518) (GH-4536)
Move footnote markers to be closer to the related terminology:
before the end of the sentence, instead of after.
(cherry picked from commit cdfe910e74)
2017-11-24 00:55:33 -08:00
Victor Stinner 733b5f3f2f
bpo-32050: Fix -x option documentation (#4423)
The line number in correct when using the -x option: Py_Main() uses
ungetc() to not skip the first newline character.
2017-11-20 07:08:44 -08:00
Masayuki Yamamoto aa9100567f Document parameters of BaseServer.finish_request() (GH-4445)
(cherry picked from commit 7750bded92)
2017-11-19 15:20:09 +03:00
Erik Bray 3393c8067d Fix typo in atexit documentation. (GH-4419) (GH-4442)
`kargs` -> `kwargs`
2017-11-17 05:57:54 -08:00
Miss Islington (bot) a2f1be0b5b bpo-15606: Improve the re.VERBOSE documentation. (GH-4366) (#4395)
(cherry picked from commit b0b44b4b33)
2017-11-14 17:39:04 +02:00
Miss Islington (bot) 47eaaa5524 bpo-31793: Doc: Specialize smart-quotes for Japanese (GH-4006)
(cherry picked from commit 5a66c8a64d)
2017-11-08 01:53:24 +09:00
Miss Islington (bot) 4376a22759 bpo-31923: Fix spelling in sqlite3 docs (GH-4227)
(cherry picked from commit aafece7a9e)
2017-11-05 02:11:25 +03:00
Serhiy Storchaka fd38819497
[2.7] bpo-18699: Corrected documentation for window.chgat in curses module (GH-1430). (#4272)
(cherry picked from commit b838cc3ff4)
2017-11-04 10:42:56 +02:00