Commit Graph

20498 Commits

Author SHA1 Message Date
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
Victor Stinner 52ba7b447f
bpo-20064: Document PyObject_Malloc() (#4204)
Document the following functions:

* PyObject_Malloc()
* PyObject_Realloc()
* PyObject_Free()

Document also the pymalloc allocator.
2017-10-31 10:08:28 -07:00
Serhiy Storchaka ef346a2473 [2.7] bpo-31667: Fix gettext related links. (GH-3860) (#4100)
* Fix incorrect links.
* Remove redundant links.
* Add signatures and index entries for gettext related
functions in the locale module.
(cherry picked from commit c02a1f4ad8)
2017-10-24 10:59:17 +03:00
Victor Stinner 355393e743 [2.7] bpo-31733, bpo-31692: Document 2 new env vars in What's New in Python 2.7 (GH-4019)
bpo-31733, bpo-31692: Document the new PYTHONSHOWREFCOUNT and
PYTHONSHOWALLOCCOUNT environment variables.
2017-10-17 13:13:13 -07:00
Victor Stinner 7b4ba62e38 [2.7] bpo-31692: Add PYTHONSHOWALLOCCOUNT env var (GH-3927)
bpo-31692, bpo-19527:

* Add a new PYTHONSHOWALLOCCOUNT environment variable, similar to
  the Python 3 "-X showalloccount" option
* When Python is compiled with COUNT_ALLOCS, the new
  PYTHONSHOWALLOCCOUNT environment variable now has to be set to dump
  allocation counts into stderr on shutdown. Moreover, allocations
  statistics are now dumped into stderr rather than stdout.
* Add @test.support.requires_type_collecting decorator: skip test if
  COUNT_ALLOCS is defined
* Fix tests for COUNT_ALLOCS: decorate some methods with
  @requires_type_collecting
* test_sys.test_objecttypes(): update object type when COUNT_ALLOCS
  is defined
2017-10-17 02:25:23 -07:00
Victor Stinner 3c082a7fdb bpo-31733: Add PYTHONSHOWREFCOUNT env var (GH-3932)
Add a new PYTHONSHOWREFCOUNT environment variable. In debug mode,
Python now only print the total reference count if PYTHONSHOWREFCOUNT
is set.
2017-10-17 01:35:19 -07:00
vyas45 50cef52372 [2.7] bpo-31754: Fix type of 'itemsize' in PyBuffer_FillContiguousStrides (GH-3993) 2017-10-16 21:23:43 +03:00
Ned Deily 356b68023d bpo-31766: restore 3.5 to docs version switchers (#3971) 2017-10-12 14:24:23 -04:00
Miss Islington (bot) 7440655bc5 bpo-31720: msilib documentation, change MsiError into MSIError (GH-3914) (GH-3916)
(cherry picked from commit 28f713601d)
2017-10-07 09:00:42 -07:00
Ned Deily 8d614bebb6 Remove retired and security branches from active docs (#3881) 2017-10-03 23:06:13 -04:00
Igor Filatov cf7197ae43 [2.7] bpo-31351: Set return code in ensurepip when pip fails (GH-3734)
Previously ensurepip would always report success, even if the
pip installation failed.

(cherry picked from commit 9adda0cdf8)
2017-09-25 11:03:24 +10:00
Zachary Ware da86874a3d [2.7] bpo-31423: Fix building the PDF documentation (GH-3693) (GH-3700)
Use prefixed macro names for the `authoraddress` function, add T2A to the font encoding in LaTeX sources to support Cyrillic characters in the PDF documentation, and replace the deprecated `font_size` config option with `pointsize`.
(cherry picked from commit da9b4cfb48)
2017-09-22 13:41:10 -05:00
Christian Heimes 5b6452d412 bpo-31533: fix broken link to OpenSSL docs (GH-3674) (GH-3676)
(cherry picked from commit 19e4d93)
2017-09-20 13:23:09 -07:00
Michael Seifert 41376241e3 bpo-29916: Include PyGetSetDef in C API extension documentation. (#831) (#3609)
(cherry picked from commit da67e0d644)
2017-09-16 14:30:07 +03:00
R. David Murray ae16b9966d [2.7] Clarify nature of parse_args 'args' argument. (GH-3292) (GH-3328)
Patch by Paul.j3.  Includes an unrelated but useful addition to the
optparse porting section.
(cherry picked from commit 0c7983e4ad)
2017-09-09 22:55:07 -07:00
Christian Heimes b9a860f3bf [2.7] bpo-29136: Add TLS 1.3 cipher suites and OP_NO_TLSv1_3 (GH-1363) (#3446)
* bpo-29136: Add TLS 1.3 support

TLS 1.3 introduces a new, distinct set of cipher suites. The TLS 1.3
cipher suites don't overlap with cipher suites from TLS 1.2 and earlier.
Since Python sets its own set of permitted ciphers, TLS 1.3 handshake
will fail as soon as OpenSSL 1.1.1 is released. Let's enable the common
AES-GCM and ChaCha20 suites.

Additionally the flag OP_NO_TLSv1_3 is added. It defaults to 0 (no op) with
OpenSSL prior to 1.1.1. This allows applications to opt-out from TLS 1.3
now.

Signed-off-by: Christian Heimes <christian@python.org>.
(cherry picked from commit cb5b68abde)
2017-09-07 22:31:17 -07:00
Miss Islington (bot) 82cae7c5be [2.7] bpo-31330: Clarify that RawTextHelpFormatter collapses repeated newlines. (GH-3272) (GH-3428)
Also provide a solution if the user wants to keep multiple blank lines.
(cherry picked from commit 397c467c49)
2017-09-07 17:17:42 -04:00
Miss Islington (bot) ab4894bba6 [2.7] bpo-21649: Add RFC 7525 and Mozilla server side TLS (GH-3387) (GH-3400)
Signed-off-by: Christian Heimes <christian@python.org>
(cherry picked from commit ad0ffa033e)
2017-09-06 17:31:48 -07:00
Benjamin Peterson 6d6ff08d38 [2.7] Issue GH-28705: greatly simplify the FAQ entry on transpiling. (#3371)
This also eliminats a dead link to Weave in the process..
(cherry picked from commit 78ffd6cffa)
2017-09-05 18:18:16 -07:00
Zachary Ware 986b7ffc65 [2.7] bpo-30450: Pull Windows dependencies from GitHub rather than SVN (GH-1783) (GH-3306)
The Windows build now depends on Python 3.6 to fetch externals, but it
will be downloaded via NuGet (which is downloaded via PowerShell) if it
is not available via `py -3.6`.  This means the only thing that must be
installed on a modern Windows box to do a full build of CPython with all
extensions is Visual Studio.

Cherry-picked from 51599e2bdd, parts of 40a23e8899, parts of 68d663cf85, d5cd21d75a, and possibly others that I've missed.

Also:

* Rename db -> bsddb for disambiguity

* Update sqlite3 to 3.14.2.0 since it's the version we use on 3.x, and it's simpler to just use it than to also upload the old version to cpython-source-deps

* Add PCbuild/*.ilk to .gitignore
2017-09-04 16:05:33 -07:00
INADA Naoki 4cde4bdcc8 bpo-31095: Fix potential crash during GC (GH-3197)
(cherry picked from commit a6296d34a4)
2017-09-04 12:31:41 +09:00
Mariatta 2281c041b2 Fix broken `Show Source` links on documentation pages (GH-3113) (GH-3128)
The `Show Source` was broken because of a change made in sphinx 1.5.1
In Sphinx 1.4.9, the sourcename was "index.txt".
In Sphinx 1.5.1+, it is now "index.rst.txt".

(cherry picked from commit b9ff498793)
2017-08-18 06:22:32 -07:00
Julien Palard 3cc46bb3ed Update the language selection in the docs language switch. (GH-3114) (#3117)
Change the option for `Français` into `French` to be consistent with the other language selections that are already in English.
(cherry picked from commit b616b97299)
2017-08-17 16:37:56 +02:00
Christian Heimes 05b7d9c667 [2.7] bpo-30714: ALPN changes for OpenSSL 1.1.0f (#3094)
OpenSSL 1.1.0 to 1.1.0e aborted the handshake when server and client
could not agree on a protocol using ALPN. OpenSSL 1.1.0f changed that.
The most recent version now behaves like OpenSSL 1.0.2 again. The ALPN
callback can pretend to not been set.

See https://github.com/openssl/openssl/pull/3158 for more details

Signed-off-by: Christian Heimes <christian@python.org>
(cherry picked from commit a5c1bab352)
2017-08-15 10:55:03 +02:00
Julien Palard fe8d9dc479 bpo-31159: fix language switch regex on unknown yet built languages. … (#3051) (#3081)
* bpo-31159: fix language switch regex on unknown yet built languages. (#3039)

This fix a regex issue (a missing non-matching group around an 'or'
list) and the specific possible case where a translation is built but
not yet in known by the picker, but not explicitly listing possible
languages in the regex.
(cherry picked from commit 122081deef)

* bpo-31149: Doc: Add Japanese to the language switcher. (#3028)

(cherry picked from commit c82b7f332a)

(cherry picked from commit e8e7fba0b2)
2017-08-13 23:44:51 +02:00
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
INADA Naoki 5aa913d723 bpo-29952: Use usual terminology of dict (GH-924)
s/keys and elements/keys and values/
(cherry picked from commit cdcac039fb)
2017-03-31 15:53:25 +09:00
Mandeep Singh 2ee01ecf41 [2.7] bpo-22392: Improve documentation for __getinitargs__ (GH-899) 2017-03-30 13:39:06 -07:00
Senthil Kumaran 3ceca68741 bpo-29917: DOC: Remove link from PyMethodDef (#890) (#896)
(cherry picked from commit c3c7ef0885)
2017-03-29 22:29:12 -07:00
Mariatta fd704a02ca bpo-16011: clarify that 'in' always returns a boolean value (GH-152) (GH-883)
(cherry picked from commit 0ae7c8bd61)
2017-03-29 14:10:13 -07:00
cocoatomo 6f95b37f29 bpo-29888: Fix the link referring to "Python download page" (GH-823) 2017-03-26 22:59:14 -04:00
cocoatomo de65804d5c Insert a missing semicolon in sgmllib documentation (#772) 2017-03-22 21:12:36 +02:00
Xiang Zhang dae5482c9c fix function name in tabnanny documentation (GH-764) 2017-03-22 15:22:44 +08:00
Mariatta 91f79db02a bpo-29856: Fix typo in curses documentation (GH-730) (GH-733)
From Shifted Dxit -> Shifted Exit in Doc/library/curses.rst
(cherry picked from commit 64508780d7)
2017-03-19 20:55:34 -07:00
Xiang Zhang 4ec14c2360 fix parameter names in ftplib documentation (GH-656) 2017-03-13 10:41:38 +08:00
cocoatomo 309fb90f68 Insert the line which should not have been deleted (#581)
see [bpo-29772](http://bugs.python.org/issue29772)
2017-03-09 08:54:27 -07:00
Mariatta fc59e5c707 bpo-29709: Improve Boolean Operations documentation (#433) (#438)
(cherry picked from commit 8eb531d9db)
2017-03-03 13:34:52 -08:00
Mariatta c8e20218d7 bpo-22594: Add a link to the regex module in re documentation (GH-241) (GH-321)
(cherry picked from commit ed6795e46f)
2017-02-26 08:56:21 -08:00
INADA Naoki 9436bbd87b bpo-29165: doc: make extending/newtypes more Python 3 friendly (GH-211)
* Use PyVarObject_HEAD_INIT instead of PyObject_HEAD_INIT on type struct header.
* Backport many minor fixes from Python 3 doc to minimize diff.
2017-02-21 21:12:03 +09:00
Senthil Kumaran af9a40d58c [2.7] Change some mercurial/ hg.python.org references. (#8) (#183)
(cherry picked from commit b2ee40ed9c)
2017-02-19 17:49:54 -08:00
INADA Naoki cf44d957ec bpo-29520: doc: fix deprecation warning from 'defindex' template (GH-180) 2017-02-20 09:45:55 +09:00
Qingpeng "Q.P." Zhang 4bfb603810 Remove redundant footnote (#181)
It was accidentally added in cc79837.
2017-02-19 22:32:51 +03:00
Mariatta e15259c2df bpo-28929: Link the documentation to its source file on GitHub (#38)
Change the documentation's `Show Source` link on the left menu
to GitHub source file.
2017-02-12 13:07:33 -08:00
Mariatta 52b8c5591b [backport to 2.7] Change documentation's `Show Source` link to GitHub (#44)
* Support "bpo-" in Misc/NEWS (#1)
Change the url to 2.7

(cherry picked from commit 79ab8be05f)

* pyspecific.py: remove space after` bpo-`
2017-02-12 12:59:20 -08:00
Mariatta 5c329882fa bpo-29474: Improve documentation for weakref.WeakValueDictionary (#11)
There were some grammatical errors in weakref.WeakValueDictionary
documentation.
2017-02-10 19:44:57 -06:00
Nick Coghlan 4e1e30dae9 Issue #26355: Specify canonical URLs in docs pages
Add canonical header link on each page to corresponding major version of the documentation.

Patch by Matthias Bussonnier.
2017-02-09 17:00:31 +01:00
Mariatta Wijaya d9fb4a97f3 Issue #29371: Clarify bitwise OR operation in doctest option flags. 2017-02-06 20:30:10 -08:00
Mariatta Wijaya ebfb2f76c5 Issue #29329: Improve documentation for hex(). Patch by Ammar Askar 2017-02-01 22:27:02 -08:00
Mariatta Wijaya 40ba60f6bf Issue #29381: Clarify ordering of UNIX shebang line as source encoding line 2017-02-01 21:14:47 -08:00
Martin Panter 60a1b351ca Issue #12067: Rewrite Comparisons section in the language reference
Some of the details of comparing mixed types were incorrect or ambiguous.
Added default behaviour and consistency suggestions for user-defined classes.
Based on patch from Andy Maier.
2017-01-21 05:14:56 +00:00
Senthil Kumaran 19048c3ada Add clarity to the warning on certificate verification in urllib. 2017-01-27 23:05:34 -08:00
Senthil Kumaran 1bfbe4fdbf issue26149 - Point to Wiki for Editors and Python IDEs on Unix.
Patch contributed by Mariatta Wijaya.
2017-01-25 01:46:33 -08:00
Martin Panter efba28c580 Issue #29189: Fix indentation in RST markup 2017-01-24 00:22:45 +00:00
Martin Panter 1b31d284e1 Issue #29274: tests cases → test cases 2017-01-18 12:14:29 +00:00
Martin Panter ea9342ae6d Avoid line breaks after hyphens, otherwise they are turned into spaces 2017-01-14 09:53:23 +00:00
Martin Panter 12344883ff Issue #15527: remove double parens by changing markup.
Patch by Serhiy Storchaka.
2017-01-14 09:40:11 +00:00
Martin Panter c7496ee6da Fix spelling and markup in documentation and code comment
* Mark up ``--help`` to avoid generating an en dash
* Use forward slash in Unix command line with a dollar sign ($) prompt
2017-01-14 08:51:49 +00:00
Alexander Belopolsky a6f10ca4d1 Closes #28130: Documented that time.tzset() updates time module globals.
Thanks Greg Bengeult for the patch.
2017-01-12 15:06:34 -05:00
Xiang Zhang da8ea3a59d Issue #29217: Fix the wrong type description of UUID.variant. 2017-01-10 11:27:07 +08:00
Berker Peksag 10434d6cb6 Issue #29189: Fix broken indentation in FancyURLopener documentation 2017-01-07 09:17:02 +03:00
Raymond Hettinger 9b7ae96b98 Issue #29023: Clarify that ints and longs are always deterministic seeds for random. 2017-01-06 16:13:37 -08:00
Benjamin Peterson ea02cdc7ec ring in 2017 for Python 2017-01-01 22:04:13 -06:00
Xiang Zhang a19fd46132 Issue #29112: Fix a questionable wording in sequence doc. 2016-12-30 11:55:28 +08:00
Xiang Zhang 58c2c6ebb8 Issue #29078: Add the missing import in datetime.time doc example.
Patch by Dhushyanth Ramasamy.
2016-12-27 12:21:28 +08:00
Martin Panter 427ca62dde Issue #1446619: Account for negative slice direction in description
Based on suggestion from Fumihiro Bessho.
2016-12-24 08:25:15 +00:00
Martin Panter 3698bd262f Issue #29004: Document binascii.crc_hqx() implements CRC-CCITT 2016-12-24 07:53:57 +00:00
Ned Deily c04957531e Update documentation index sidebar for 3.6.0 release. 2016-12-23 04:12:46 -05:00
Xiang Zhang c4f91baa35 Issue #29038: Fix duplicate get_ca_certs() doc entry. 2016-12-23 11:10:19 +08:00
Brett Cannon 00ebffe5e1 Grammatical fixes for d95f19892fd0 2016-12-22 10:03:11 -08:00
Victor Stinner f6447e0065 doc: Suggest to hash(tuple of attr) rather than XOR
Issue #28383: __hash__ documentation recommends naive XOR to combine but this
is suboptimal. Update the doc to suggest to reuse the hash() method using a
tuple, with an example.
2016-12-19 13:15:35 +01:00
Brett Cannon 37eb788e9e Update the porting HOWTO 2016-12-17 12:38:54 -08:00
Serhiy Storchaka 30ad6e2c46 Issue #14061: Misc fixes and cleanups in archiving code in shutil.
Improved the documentation and tests for make_archive().
Improved error handling when corresponding compress module is not available.
External zip executable is now used if the zlib module is not available.
2016-12-16 19:04:17 +02:00
Martin Panter 3eb92e06df Issue #28916: No special case for leading zeros with %x alternative form 2016-12-11 03:51:44 +00:00
Ned Deily 3797922ad9 Issue #28900: Update documentation sidebar for 3.6.0rc. 2016-12-07 23:34:23 -05:00
Serhiy Storchaka 8b5528782a Fixed mismatching title overline. 2016-12-04 15:42:13 +02:00
Serhiy Storchaka e7f555b969 Fixed double hyphens that are rendered to literal en-dashes in the documenation. 2016-12-04 10:20:18 +02:00
Ned Deily 32b3734866 Issue #28440: No longer add /Library/Python/site-packages, the Apple-supplied
system Python site-packages directory, to sys.path for macOS framework builds.
The coupling between the two Python instances often caused confusion and, as
of macOS 10.12, changes to the site-packages layout can cause pip component
installations to fail.  This change reverts the effects introduced in 2.7.0
by Issue #4865.  If you are using a package with both the Apple system Python
2.7 and a user-installed Python 2.7, you will need to ensure that copies of
the package are installed with both Python instances.
2016-12-03 02:14:09 -05:00
Serhiy Storchaka 1ae56fb9ee Issue #21818: Fixed references to classes that have names matching with module
names.
2016-12-02 23:13:42 +02:00
Martin Panter b398d2c2bf Issue #28771: Correct documentation of signatures using const 2016-12-01 01:32:16 +00:00
Martin Panter ed82604e3f Issue #25701: Document that some C APIs can both set and delete items
Also document that using the dedicated functions to delete items is
preferred. Using PyObject_SetAttr/String() and PySequence_SetItem/Slice() for
deletion is deprecated.
2016-11-30 10:32:40 +00:00
Martin Panter a52b567a3f Issue #28820: Fix spelling of “practice” as a noun 2016-11-30 10:18:45 +00:00
Serhiy Storchaka 0092bc7279 Issue #28763: Use double hyphens (rendered as en-dashes) in numerical ranges
in the documentation.
2016-11-26 13:43:39 +02:00
Serhiy Storchaka e4a147b1bd Fixed the documentation of the structure PyMethodDef.
The fields ml_name and ml_doc are of type "const char *" rather of "char *".
2016-11-21 11:37:18 +02:00
Martin Panter 3738ef4294 Change double hyphens (en dashes) to em (longer) dashes 2016-11-21 00:21:39 +00:00
Serhiy Storchaka 58b6b985a0 Fixed the documentation of parse_constant argument in json.load().
parse_constant doesn't get called on 'null', 'true', 'false' since 3.1/2.7.
2016-11-12 22:47:16 +02:00
Terry Jan Reedy fed0883e94 Issue #28615: Backport imaginary/complex number text from 3.x.
Patch by Mariatta Wijaya.
2016-11-11 19:09:50 -05:00
Martin Panter b26a7d18ef Fix spacing after C++ in documentation 2016-11-05 03:15:20 +00:00
Serhiy Storchaka b858d7f074 Issue #28513: Documented command-line interface of zipfile. 2016-11-02 12:05:54 +02:00
Martin Panter 39d74a9108 Issue #26638: Cannot directly link to main option from the “timeit” module
This seems to be because the “timeit” module defines its own set of options
2016-10-30 05:41:04 +00:00
Martin Panter e3e362e398 Issue #26638: Mask undefined CLI options to defeat new Sphinx warnings 2016-10-30 05:19:02 +00:00
Martin Panter ee01fccc69 Issue #26638: Disable inappropriate links to Python interpreter options 2016-10-30 05:24:45 +00:00
Serhiy Storchaka f831fd3f19 Issue #22949: Documented that fnmatch.translate() is for use with re.match(). 2016-10-27 22:47:08 +03:00
Serhiy Storchaka d585c52511 Issue #28496: Mark up constants 0, 1 and -1 that denote return values or
special input values as literal text.
2016-10-27 21:41:04 +03:00
Serhiy Storchaka cb042e0448 Issue #19795: Fixed formatting a table. 2016-10-19 19:37:20 +03:00
Serhiy Storchaka dc0e3a8907 Issue #19795: Improved more markups of True/False. 2016-10-19 18:30:16 +03:00
Serhiy Storchaka e3d5787a25 Issue #19795: Mark up True and False as literal text instead of bold. 2016-10-19 16:43:18 +03:00
Serhiy Storchaka ad13f338ce Issue #19795: Mark up None as literal text. 2016-10-19 16:29:10 +03:00
Victor Stinner 5df6d48ce5 Issue #27896: Allow passing sphinx options to Doc/Makefile
Patch written by Julien Palard.
2016-10-16 19:14:23 +02:00
Martin Panter 197332ae5a Issue #27800: Document limitation and workaround for multiple RE repetitions 2016-10-15 01:18:16 +00:00
Guido van Rossum 50f40724c5 Issue #18789: Update XML vulnerability table to use Safe/Vulnerable instead of No/Yes. (backport to 2.7) 2016-10-13 14:34:20 -07:00
Serhiy Storchaka 0ea51b18d5 Issue #18287: PyType_Ready() now checks that tp_name is not NULL.
Original patch by Niklas Koep.
2016-10-07 23:24:35 +03:00
Terry Jan Reedy dace77c530 Issue #28815: Change '?' to '<module>' in some doc examples.
Patch by Mariatta Wijaya.
2016-09-30 15:38:41 -04:00
Berker Peksag 6f959d07db Issue #26550: Fix typo in webservers HOWTO
Reported by Alejandro Soini.
2016-09-29 02:32:51 +03:00
Martin Panter de2d4d2048 Issue #26439: Document that RTLD_NOW is always added 2016-09-27 05:10:40 +00:00
Ned Deily 47f190a072 Make 3.7 the current dev version in the html version of the docs. 2016-09-20 14:58:38 -04:00
Raymond Hettinger 84a449abb3 Issue #28104: More accurately document set method signatures 2016-09-12 23:43:03 -07:00
Terry Jan Reedy 87bcc1d646 Issue #15308: Add 'interrupt execution' (^C) to Shell menu.
Patch by Roger Serwy, updated by Bayard Randel.
2016-09-12 01:49:55 -04:00
Raymond Hettinger 63c79966d5 Issue #26557: Note that mapping view methods are not present in UserDict or shelves. 2016-09-11 20:38:27 -07:00
Vinay Sajip 0954ac1b5c Issue #23105: Updated documentation on open() flag constants. 2016-09-11 15:11:50 +01:00
Martin Panter fcc8a0f0f5 Correct spelling in documentation and code comments 2016-09-10 10:38:28 +00:00
Martin Panter ba5480b656 Issue #27993: Fix problems with the plural “objects” in docs and comments 2016-09-08 05:39:59 +00:00
R David Murray 039f184654 #26209: Clarify type of *localaddr*/*remoteadr* in smtpd docs. 2016-09-07 14:09:51 -04:00
Christian Heimes 4e64c2c838 Fix ssl documentation and remove merge accident 2016-09-06 23:41:37 +02:00
Christian Heimes d988f429fe Issues #27850 and #27766: Remove 3DES from ssl default cipher list and add ChaCha20 Poly1305. 2016-09-06 20:06:47 +02:00
Christian Heimes c2fc7c4f53 Issue #26470: Port ssl and hashlib module to OpenSSL 1.1.0. 2016-09-05 23:37:13 +02:00
Raymond Hettinger 56c5152370 Issue #27706: Document that random.seed() is non-deterministic when PYTHONHASHSEED is enabled 2016-08-31 14:57:32 -07:00
Terry Jan Reedy 580ca656bd Backport spelling fix. 2016-08-30 16:57:53 -04:00
Serhiy Storchaka e63af905a4 Issue #27861: Fixed a crash in sqlite3.Connection.cursor() when a factory
creates not a cursor.  Patch by Xiang Zhang.
2016-08-29 14:29:55 +03:00
Terry Jan Reedy 558c0de2d4 Issue #25564: Mention exec and __builtins__ in IDLE-console difference section.
Do not print charrefs outside of the text proper (like '—»»»» ').
2016-08-25 01:21:54 -04:00
Martin Panter 99496760c7 Fix some spelling errors 2016-08-20 08:00:53 +00:00
R David Murray 4ae4e7cbc0 #27753: fix typo (name->named). 2016-08-13 14:46:23 -04:00
Raymond Hettinger af0b38f814 Issue #27720: Fix error in eng_to_decimal docs and add examples from the specification. 2016-08-13 11:10:23 -07:00