Commit Graph

20294 Commits

Author SHA1 Message Date
Julien Palard 245dafca85 bpo-31045: Language switch (#2652) (#3024)
* Doc: Indicate the language

* Renaming version_switcher to switchers (to add language_switcher).

* Adding language switch.

* Doc switchers: Enhance readability of regex parsing versions.

* Doc switchers: Desambiguate the need of a replace(/\/+$/g, '') by proper naming.

* Doc switchers: py3k can't reach js, it's redirected server-side by nginx.

* Doc switchers: Examples matching actual regexes.

* Doc switchers: Better fallback on unexisting translated version.

(cherry picked from commit dff9b5f9d6)
2017-08-08 14:14:23 +02:00
Subhendu Ghosh dd6e4aa113 bpo-27470: Improve doc for commandline -3 option
Mention that it warns about features that are significantly changed in Python 3
and can’t be detected using static code analysis.

Link to Porting Python 2 Code to Python 3 doc
2017-08-04 12:00:10 +10:00
Mariatta fa90179e07 Fix trivial typo in multiprocessing documentation (GH-2930) (GH-2942)
(cherry picked from commit 6fcb69dad5)
2017-07-28 19:55:04 -07:00
Aditya Hase 0666d0e504 bpo-30304: Improve TestCase.assertMultiLineEqual docs (GH-2847)
Mention that TestCase.assertMultiLineEqual method is used by default when comparing Unicode string when comparing Unicode strings with assertEqual.
2017-07-25 13:59:52 -07:00
Nicholas 82a77d38d6 [2.7] bpo-30964: Mention ensurepip in package installation docs (GH-2795)
Adds a new 'Pip not installed' section that covers
running `ensurepip` manually, and also references
the relevant section of the Python Packaging User
Guide.

(cherry picked from commit b3527bfefd)
2017-07-21 16:29:44 +10:00
Mariatta 598f26b788 [2.7] Fix typo in Turtle Docs: yingyang -> yinyang (GH-2770) (GH-2780)
(cherry picked from commit fff2a21057)
2017-07-20 07:14:46 -07:00
Ned Deily 3b1e72662a Update doc download files size estimates. (#2774) 2017-07-20 04:45:42 -04:00
Ned Deily 64a9f3d961 bpo-30939: Avoid Sphinx deprecation warning in docs build. (#2721) (#2725)
(cherry picked from commit 50f58163a6)
2017-07-15 23:06:57 -04:00
Xiang Zhang a948d4f753 Add a missing asterisk in traceback doc to complete formatting (#2675) 2017-07-12 11:41:33 +08:00
Kit Sunde 5d1554a2eb json Docs: Trivial update to the code example (GH-2465)
Replace `dumps` with `json.dumps`
2017-07-10 13:05:25 -07:00
Berker Peksag 2e5867d93a Remove outdated FOX from GUI FAQ (GH-2538)
FXpy doesn't have a Python 3 port and it only
supports Python 2.2 and older versions.

Reported by Alex Walters on docs@p.o.

(cherry picked from commit d3ed2877a7)
2017-07-04 09:27:48 +03:00
Dmitry Tokarev 311ae46e7b [2.7] Docs: fixed placement of .. _func-list: in functions.rst (#2520)
Oh, this is my fault too. I missed this mistake. Thank you for the correction.
2017-06-30 22:35:44 +03:00
Dmitry Tokarev 58bb0d84ce Fixed 2.7 docs - links to list, backported from python3.x (#2518) 2017-06-30 22:02:59 +03:00
regexaurus 5b5002c466 Clarification to the `break` statement (GH-2453) (GH-2459)
Clarify that the break statement breaks out of the innermost enclosing for or while loop.
(cherry picked from commit 36fc896740)
2017-06-27 19:36:15 -07:00
Mariatta 508267437c [2.7] bpo-30709: Improve code example in Descriptor HowTo doc (GH-2339) (GH-2340)
(cherry picked from commit b066edfb1b)
2017-06-22 21:24:23 -07:00
Xiang Zhang b39a7481ee bpo-30176: Add missing curses cell attributes constants (#2278) 2017-06-19 22:12:45 +08:00
Mariatta 4b30107bfd bpo-30659 : Use ** for kwargs in namedtuple._replace() signature (GH-2173) (GH-2196)
(cherry picked from commit 184bd82ba8)
2017-06-14 12:07:42 -07:00
csabella 311054a928 Fix trivial typo in Python Setup documentation (GH-2185) (GH-2190)
Replace platform with platforms.
(cherry picked from commit 4ebf03d109)
2017-06-14 09:26:03 -07:00
Antoine Pitrou 15a6127e72 [2.7] Mention how to disable signal fd wakeup (GH-2140) (#2151)
(cherry picked from commit d79c1d4a94)
2017-06-13 10:21:28 +02:00
Marco Buttu bbb335891c bpo-30217: add the operators ~ and | to the index (GH-1502) (GH-2137)
(cherry picked from commit dc980dfbcf)
2017-06-12 12:42:47 -07:00
Mariatta 107949cb87 bpo-30621: Update Input Output Tutorial Example(GH-2074) (GH-2120)
import json before using json module
(cherry picked from commit 1dbce04d0e)
2017-06-11 18:59:33 -07:00
Zachary Ware 5fe8ac69f9 [2.7] bpo-27425: Be more explicit in .gitattributes (GH-840) (GH-2086)
Also updates checked-in line endings in several files.
2017-06-11 14:19:39 -05:00
Mariatta 9660a7e4bb bpo-25409: Clarify fnmatch and fnmatchcase documentation (GH-1535) (GH-2067)
Mention that fnmatchcase does not call normcase, and fnmatch does.
(cherry picked from commit e5f6e86c48)
2017-06-10 07:26:39 -07:00
Mariatta 662d856cd7 bpo-30499: Remove a deprecated note about sets. (GH-1848) (GH-1907)
(cherry picked from commit 0737ee2067)
2017-06-01 07:12:18 -07:00
Mariatta 9139f23464 bpo-22702: Clarify documentation of str.join & bytes.join (GH-156) (GH-1898)
The "iterable iterable" phrasing created confusion between the term
reference and the parameter name.

This simplifies the phrasing to just use the parameter name
without linking directly to the term definition..
(cherry picked from commit 08e2f355d0)
2017-05-31 19:49:30 -07:00
Mariatta e81aa87562 [2.7] Fix a trivial typo in global section (GH-1497) (GH-1882)
(cherry picked from commit f34c685020)
2017-05-30 22:08:19 -07:00
Stéphane Wirtel 2bb6eb3fbb [2.7] Indent methods and attributes of MimeType class (GH-1306) (#1801) 2017-05-25 10:11:30 -07:00
Brian Ward 9395ca40f2 added re.UNICODE effects to insensitive flags (#1781) 2017-05-24 00:08:41 -07:00
delirious-lettuce 374e57d928 [2.7] Fix typos in multiple `.rst` files (GH-1668) (#1707) 2017-05-22 20:16:53 +03:00
Serhiy Storchaka b8b9f95f66 [2.7] bpo-30380: Fix Sphinx 1.6.1 warnings. (GH-1613) (#1616)
* Use explicit numbering for footnotes referred by explicit number.
* Fix literal strings formatting in howto/urllib2.rst.
* Add `:noindex:` to duplicated definition of list.
* Update susp-ignored.csv for reference/expressions.rst.
(cherry picked from commit d97b7dc94b)
2017-05-17 01:26:48 +03:00
Zachary Ware f6c6d1e230 bpo-11681: Document the `-b` and `-bb` options (GH-1562) 2017-05-13 09:30:20 -05:00
Zachary Ware 4be66b6cd1 Fix warnings due to deprecated latex options (GH-1563) 2017-05-13 09:16:44 -05:00
Zachary Ware c7362b4b08 Update susp-ignored.csv (GH-1564) 2017-05-13 09:16:25 -05:00
Mariatta e1b02ff588 [2.7] bpo-28315: Improve code examples in docs (GH-1372) (#1447)
Replace
   File "<stdin>", line 1, in ?
with
   File "<stdin>", line 1, in <module>.
(cherry picked from commit 8856940cf2)
2017-05-03 18:54:28 -07:00
Serhiy Storchaka 43566aee12 [2.7] bpo-30223: Add Lib/test/__main__.py. (#1373)
To unify running tests in Python 2.7 and Python 3, the test
package can be run as a script.  This is equivalent to running the
test.regrtest module as a script.
2017-05-02 18:26:25 +03:00
Serhiy Storchaka a694e092f6 bpo-30207: Rename test.test_support to test.support. (#1353)
To simplify backports from Python 3, the test.test_support module
was converted into a package and renamed to test.support.  The
test.script_helper module was moved into the test.support package.
Names test.test_support and test.script_helper are left as aliases to
test.support and test.support.script_helper.
2017-04-30 11:36:58 +03:00
csabella 4734c2d5c0 [2.7] bpo-30208: DOC: fix small typos in IDLE (#1358)
(cherry picked from commit d9af73330f)
2017-04-29 20:44:04 -04:00
Mariatta 24404b4c92 [2.7] bpo-30182: Use the correct name for ISO in Unicode HOWTO. (GH-1312). (#1315)
(cherry picked from commit 6fde770e4e)
2017-04-26 22:25:40 -07:00
Dong-hee Na 19b3a4885c [2.7] bpo-30142: Remove "callable" from the 2to3fixer documentation. (GH-1305) 2017-04-26 09:55:32 -07:00
Serhiy Storchaka bfc7dff63b [2.7] bpo-15718: Document the upper bound constrain on the __len__ return value. (GH-1256). (#1261)
(cherry picked from commit 85157cd89a)
2017-04-23 08:58:09 +03:00
Berker Peksag fb12365c43 Remove redundant comma in argparse HOWTO (GH-1141)
Reported by Sean Canavan on docs@p.o.

(cherry picked from commit 8526fb74ed)
2017-04-20 07:41:01 +03:00
cocoatomo 450a69c6a4 bpo-19225: Remove duplicated description for standard warning categories (GH-1068) 2017-04-20 06:57:21 +03:00
Christopher Snyder 32c43fbfee Fix typo in HTTPConnection.set_tunnel description (#1179) 2017-04-19 08:45:16 -07:00
Michael Seifert 0b46fcf45a [2.7] bpo-30059: Include Py_Ellipsis in C API documentation (GH-1018) (GH-1147) 2017-04-14 19:04:22 -07:00
Serhiy Storchaka 53ad68434c bpo-30021: Add examples for re.escape(). (#1048) (#1118)
And fix the parameter name.

(cherry picked from commit 8fc7bc2b76)
2017-04-13 19:47:18 +03:00
Mariatta e0cba5b45a [2.7] bpo-29521: Fix two minor documentation build warnings (GH-41) (GH-670)
(cherry picked from commit 3d707be950)
2017-04-10 10:27:50 -07:00
Mariatta 7026cd92c0 [2.7] Correct typo in configparser.rst (GH-1012) (GH-1026)
(cherry picked from commit 01fa9ae546)
2017-04-09 15:16:06 -07:00
Nick Coghlan ab16dc180e bpo-29506: Clarify deep copy note in copy module
The reference to administrative data was confusing to readers,
so this simplifies the note to explain that deep copying may copy
more then you intended, such as data that you expected to be
shared between copies.

Patch by Sanyam Khurana.
2017-04-09 20:57:29 +10:00
cocoatomo 7f85947106 [2.7] bpo-19225: Lack of c api exceptions doc (#964)
* Keep the c-api exception doc up-to-date

cherry-pick'ed from ec1f5df..e3d6db3 and fix conflict
2017-04-08 09:19:24 +03:00
Eric Wieser 9b50786bc7 Fix references within buffer protocol docs (#1016) 2017-04-06 20:36:43 +03:00