Commit Graph

20465 Commits

Author SHA1 Message Date
Ned Deily e2543a67fb Include additional changes to support blurbified NEWS (#3340) 2017-09-05 00:10:31 -07:00
Gregory P. Smith d50ce4fcc9 [3.6] Added effect of re.ASCII and reworded slightly (GH-1782) (#3313)
(cherry picked from commit c9d6dbc290)
2017-09-04 14:58:31 -07:00
Benjamin Peterson 703fdb837a [3.6] remote note about IRIX in aifc (#3304)
This comment hasn't been true since Python 3.0.
(cherry picked from commit b84efddb9a)
2017-09-04 13:58:23 -07:00
larryhastings 6a116c2aa4 Blurbify 3.6. (#3287)
Blurbify 3.6.
2017-09-04 12:03:25 -07:00
INADA Naoki 2eea952b1b bpo-31095: fix potential crash during GC (GH-3195)
(cherry picked from commit a6296d34a4)
2017-09-04 12:31:09 +09:00
Gregory P. Smith d4097353ba [3.6] Fix a typo in the Programming FAQ. (GH-3230) (#3273)
subobjects, not subobjecs.
(cherry picked from commit e9d978fd1b)
2017-09-03 13:29:34 -07:00
Mariatta b5db7bb9da [3.6] Fix the indentation in Extending Python code example (GH-3244) (GH-3250)
Code was indented with three spaces.
Fixed using four spaces.
(cherry picked from commit d9a2b99ac4)
2017-08-30 23:11:02 -07:00
Mariatta 83e5c888ff [3.6] bpo-26656: Improve re.compile documentation (GH-3211) (GH-3225)
- Link to the regular expressions object documentation
- Clarify that it can be used with more than the two methods currently stated.
(cherry picked from commit ed94a8b285)
2017-08-27 22:50:08 -07:00
Mariatta 2dfafa3c56 bpo-31191: Improve grammar in threading.Barrier docs (GH-3080) (GH-3224)
(cherry picked from commit 143be36629)
2017-08-27 15:19:08 -07:00
Mariatta ff64a24c67 Fix broken `Show Source` links on documentation pages (GH-3113) (GH-3125)
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:21:33 -07:00
Julien Palard fcecb0e365 Update the language selection in the docs language switch. (GH-3114) (#3115)
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:00 +02:00
Christian Heimes 7f6a13bd56 [3.6] bpo-30714: ALPN changes for OpenSSL 1.1.0f (#3093)
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:45:40 +02:00
Julien Palard e8e7fba0b2 bpo-31159: fix language switch regex on unknown yet built languages. … (#3051)
* 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)
2017-08-10 16:54:26 +02:00
Julien Palard e93135dbb2 bpo-31045: Language switch (#2652) (#3023)
* 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:13:53 +02:00
Mariatta 9b3abacf87 [3.6] Improve grammar in asyncio documentation (GH-2993) (GH-2994)
"not only is it .." is the correct form, as opposed to:
"not only it is ..."
(cherry picked from commit 87c3c5de73)
2017-08-04 00:33:33 +10:00
Terry Jan Reedy 4c7b368de7 [3.6] bpo-30803: clarify truth value testing documentation (GH-2508) (#2946)
Initial patch by Peter Thomassen.
(cherry picked from commit caa1280)
2017-07-29 18:56:06 -04:00
Mariatta e05119ad4e Fix trivial typo in multiprocessing documentation (GH-2930) (GH-2940)
(cherry picked from commit 6fcb69dad5)
2017-07-28 19:55:23 -07:00
Mariatta 0dbfab2ac7 Add the link to asyncio source code in the docs (GH-2373) (GH-2884)
(cherry picked from commit 627d2c8e8d)
2017-07-25 21:05:17 -07:00
Mariatta 59e6ab15e4 bpo-26506: hex() documentation: mention %x % int (GH-2525) (GH-2870)
(cherry picked from commit 67ba4fa467)
2017-07-25 11:04:08 -07:00
Terry Jan Reedy 548a6889f4 [3.6] Minor typo in curses.rst (GH-2763) (#2853)
I found a tiny typo in the curses how-to: changed 'Thy' to 'The' on line 68.
(cherry picked from commit d439d3e)
2017-07-24 18:54:53 -04:00
Nicholas df5837b5a9 [3.6] bpo-30964: Mention ensurepip in package installation docs (GH-2797)
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:44:43 +10:00
Trey Hunner ef4231adb7 bpo-30466: Add brief explanation of classes to tutorial (GH-1804) (GH-2700) 2017-07-20 20:10:54 -07:00
Mariatta 7f58994842 [3.6] Fix typo in Turtle Docs: yingyang -> yinyang (GH-2770) (GH-2778)
(cherry picked from commit fff2a21057)
2017-07-20 07:14:05 -07:00
Ned Deily e0d306f682 Update doc download files size estimates. (#2771) (#2772) 2017-07-20 04:19:22 -04:00
Steve Dower e99d3a52a5 [3.6] bpo-30450: Improved logic for obtaining dependencies (#2751)
Adds alternate download approach for nuget.exe
Fall back to git.exe if no Python is found. (#2739)
Also check whether git.exe is on PATH if it will be used.
Add support for HOST_PYTHON variable.
Clear internal environment variables used in find_python.bat
Use HOST_PYTHON as the actual Python if it is recent enough.
Adds HOST_PYTHON variable to AppVeyor configuration
2017-07-19 09:11:08 +02:00
Ned Deily bbd0f423d2 bpo-30939: Avoid Sphinx deprecation warning in docs build. (#2721) (#2722)
(cherry picked from commit 50f58163a6)
2017-07-15 16:56:13 -04:00
Łukasz Rogalski ea9cbe0a5c Doc that 'sorted' args are keyword-only, fix 'reverse' default (#2709)
backport
2017-07-14 15:57:19 -04:00
Berker Peksag 23e2c3d193 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:35 +03:00
Kojo Idrissa 03af428242 [3.6] bpo-29933: Improve set_write_buffer_limits description (GH-2262) (GH-2532)
Improve the description of the high and low parameters for set_write_buffer_limits.
Also fixed a small grammatical issue.
(cherry picked from commit 5200a7c7f9)
2017-07-01 19:48:07 -07:00
regexaurus c4cc5534fd Clarification to the `break` statement (GH-2453) (#GH-2457)
Clarify that the break statement breaks out of the innermost enclosing for or while loop.
(cherry picked from commit 36fc896740)
2017-06-27 19:38:22 -07:00
Benjamin Peterson bae5ddab2c fix some reference to Unicode 8 that should be to Unicode 9 (#2346) 2017-06-22 23:11:52 -07:00
Mariatta d79ac2c246 [3.6] bpo-30709: Improve code example in Descriptor HowTo doc (GH-2339) (GH-2342)
(cherry picked from commit b066edfb1b)
2017-06-22 21:24:43 -07:00
Mariatta 8baf78b98f [3.6] bpo-30619: Clarify typing.Union documentation (GH-2326) (GH-2337)
When a class and its subclass are present, the latter is skipped.
(cherry picked from commit 6580c19bbb)
2017-06-22 18:52:57 -07:00
Serhiy Storchaka a1115e1a04 [3.6] bpo-29755: Fixed the lgettext() family of functions in the gettext module. (GH-2266) (#2297)
They now always return bytes.

Updated the gettext documentation..
(cherry picked from commit 26cb4657bc)
2017-06-20 18:06:35 +03:00
Mariatta 0a4fe1d857 [3.6] bpo-30420: List cwd parameter in subprocess convenience APIs (GH-1685) (GH-2253)
Partially clarify the subprocess convenience API documentation by
explicitly listing the `cwd` parameter in their abbreviated signatures.

While this has been merged as an improvement, it doesn't fully
resolve the issue, as the `cwd` should also be covered in the
"Frequently Used Arguments" section, and the fact these APIs
pass unlisted keyword arguments down to the lower level APIs
is currently still unclear.
(cherry picked from commit 368cf1d206)
2017-06-19 20:28:16 -07:00
Mariatta 304a96e586 bpo-30176: Add missing curses cell attributes constants (GH-1302). (GH-2241)
(cherry picked from commit 116dd5eba6)
2017-06-16 07:19:56 -07:00
Mariatta 6a90a12470 bpo-30656: Fix Python C API Module Objects documentation (GH-2170) (GH-2230)
`PyModule_New()` now refers to `PyModule_NewObject()`
(cherry picked from commit 2d0afef82a)
2017-06-15 18:49:43 -07:00
Mariatta 789f47ebb5 bpo-30659 : Use ** for kwargs in namedtuple._replace() signature (GH-2173) (GH-2195)
(cherry picked from commit 184bd82ba8)
2017-06-14 11:59:37 -07:00
csabella dd47b1944d Fix trivial typo in Python Setup documentation (GH-2185) (GH-2188)
Replace platform with platforms.
(cherry picked from commit 4ebf03d109)
2017-06-14 09:26:41 -07:00
terryjreedy 22d909f8c2 [3.6]bpo-25514: Improve IDLE's connection refused message (#2177) (#2178)
When IDLE fail to start because the socket connection fails, direct people to a new subsection of the IDLE doc listing various causes and remedies.
(cherry picked from commit 188aedf8bb)
2017-06-13 22:13:15 -04:00
Antoine Pitrou d0d63dc1e8 [3.6] Mention how to disable signal fd wakeup (GH-2140) (#2149)
(cherry picked from commit d79c1d4a94)
2017-06-13 10:23:13 +02:00
Mariatta 81c05ccc10 bpo-6519: Improve Python Input Output Tutorial (GH-2143) (GH-2145)
Move up the discussion about 'with' keyword, so it appears earlier in the document.
(cherry picked from commit bd4e9e0ca9)
2017-06-12 22:40:18 -07:00
Marco Buttu f59cac4b64 bpo-30217: add the operators ~ and | to the index (GH-1502) (GH-2136)
(cherry picked from commit dc980dfbcf)
2017-06-12 12:41:42 -07:00
Nick Coghlan e1b690370f bpo-23404: `make regen-all` What's New entry (#2128)
While the build changes won't affect most users,
they may affect redistributors and folks building
their own Python binaries from source.
2017-06-12 22:28:12 +10:00
Mariatta 47c9decb5f bpo-30621: Update Input Output Tutorial Example(GH-2074) (GH-2118)
import json before using json module
(cherry picked from commit 1dbce04d0e)
2017-06-11 18:59:05 -07:00
Benjamin Peterson 2737291134 backport ssl doc fixes (#2117)
* clarify recv() and send() on SSLObject (#2100)

SSLObject has recv() and send(), but they don't do any network io.

* remove extra word (#2101)
2017-06-11 11:53:14 -07:00
Zachary Ware f57e34b672 [3.6] Use Travis to make sure all generated files are up to date (GH-2080) (GH-2092)
(cherry picked from commit 0afbabe245)

Also fixes some line endings missed in GH-840 backport.
2017-06-11 11:30:57 -05:00
KatherineMichel 865ed9ea67 bpo-30312: Small correction in datastructures set code sample (GH-2081) (GH-2085)
(cherry picked from commit ca81615344)
2017-06-10 13:33:57 -07:00
Mariatta 76eabd3a21 bpo-25409: Clarify fnmatch and fnmatchcase documentation (GH-1535) (GH-2065)
Mention that fnmatchcase does not call normcase, and fnmatch does.
(cherry picked from commit e5f6e86c48)
2017-06-10 07:25:33 -07:00
Mariatta 10c9a09ef4 [3.6] bpo-30335: Add deprecation alias entry for assertNotRegexpMatches (GH-1536) (GH-2055)
Document that assertNotRegexpMatches is a deprecated alias for assertNotRegex.
(cherry picked from commit 74921ed894)
2017-06-09 18:33:31 -07:00
Mariatta af609a00a6 bpo-24755: Document asyncio.wrap_future (GH-603) (GH-2019)
(cherry picked from commit 824f687912)
2017-06-09 07:32:46 -07:00
Nick Coghlan c422959dac [3.6] bpo-19180: Updated references for RFC 1750, RFC 3280 & RFC 4366
* RFC 1750 has been been obsoleted by RFC 4086.
* RFC 3280 has been obsoleted by RFC 5280.
* RFC 4366 has been obsoleted by RFC 6066.
(cherry picked from commit 63c2c8ac17)
2017-06-09 22:37:53 +10:00
gfyoung 063f0b3583 bpo-29596: Improve clinic howto documentation (GH-1710) (GH-1976)
Clarify that `two-pass` buffer can only be dumped once, and it prints out all text sent to it during all processing, even from Clinic blocks *after* the dumping point.
2017-06-06 14:17:18 -07:00
wim glenn b25b7254d9 bpo-30583: Fix typo in datetime dateutil documentation (GH-1972) (GH-1974)
Replace `datetuil` into `dateutil`
(cherry picked from commit 53f2af1655)
2017-06-06 12:32:14 -07:00
Nick Coghlan 798cfb2123 bpo-30052: Always regenerate cross-references (GH-1339) (GH-1921)
The patch for bpo-30052 changed the preferred link target
for :func:`bytes` and :func`bytearray` references to be the
respective type definitions rather than the corresponding
builtin function entries.

This patch changes the daily documentation builds to disable
the output caching in Sphinx, in order to ensure that
cross-reference changes like this one are reliably picked
up and applied automatically after merging.
(cherry picked from commit 7a82f9c2b9)
2017-06-05 19:19:37 -07:00
csabella ce40550acd bpo-30538: Update count() in Functional Programming HOWTO (GH-1919) (GH-1943)
* bpo-30538: Update count() in Functional HOWTO
* bpo-30538: Update enumerate() arguments in Functional HOWTO
(cherry picked from commit 9be4ff359d)
2017-06-04 20:12:23 -07:00
Mariatta 86eb93fae6 bpo-30530: Update Descriptor How To Documentation (GH-1845) (GH-1953)
Update the code example in Functions and Methods section
Remove objtype argument in MethodType
(cherry picked from commit 1bced56567)
2017-06-04 20:06:48 -07:00
Mariatta 1c92c0edca bpo-30052: Link `bytes` & `bytearray` to stdtypes not functions (GH-1271) (GH-1915)
Builtin container types have two potential link targets in the docs:

- their entry in the list of builtin callables
- their type documentation

This change brings `bytes` and `bytearray` into line with other
container types by having cross-references default to linking to
their type documentation, rather than their builtin callable entry..
(cherry picked from commit c6db4811f9)
2017-06-01 21:56:24 -07:00
Matthias Bussonnier e417d12d72 bpo-29660: traceback: Document that etype is ignored in some places. (GH-344) (GH-1913)
(cherry picked from commit cdb89cd)
2017-06-01 20:26:15 -07:00
Mariatta 9d752aa5e6 bpo-30499: Remove a deprecated note about sets. (GH-1848) (GH-1905)
(cherry picked from commit 0737ee2067)
2017-06-01 07:12:01 -07:00
Mariatta 9522159bc4 bpo-22702: Clarify documentation of str.join & bytes.join (GH-156) (GH-1897)
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:01 -07:00
csabella 9abd0bf68f bpo-27618: Clarify that threading.Lock is a factory function (GH-1307) (GH-1894)
(cherry picked from commit 56ddfd2eea)
2017-05-31 18:53:24 -07:00
Mariatta e49c5e9277 [3.6] Fix a trivial typo in global section (GH-1497) (GH-1880)
(cherry picked from commit f34c685020)
2017-05-30 22:08:04 -07:00
Mariatta 60b257b01c bpo-17188: add missing periods at the end of sentences (GH-1875) (GH-1876)
(cherry picked from commit 9efad1e5ae)
2017-05-30 15:37:43 -07:00
csabella ad13d54646 bpo-30354: Update data model documentation for super() (GH-1561) (GH-1868)
The data model section of the language reference was written well
before the zero-argument form of super() was added.

To avoid giving the impression that they're doing something
unusual, this updates the description of `__new__` and `__init__`
to use the zero-argument form.

Patch by Cheryl Sabella.
(cherry picked from commit 12b1c18098)
2017-05-30 13:48:22 -07:00
csabella 00b381b9a7 bpo-17188: DOC: Document 'from None' in raise statement (GH-1671) (GH-1867)
Original patch by Dennis Mårtensson.
(cherry picked from commit 763557eac0)
2017-05-30 13:27:39 -07:00
Mariatta 03c7600982 Improve grammar in The Import System documentation (GH-1862) (GH-1863)
Replace `an ModuleNotFoundError` with `a ModuleNotFoundError`.
Replace `an path` with `a path`.
(cherry picked from commit 9c972b5780)
2017-05-30 09:29:06 -07:00
Mariatta d52f47a8f7 [3.6] bpo-30361: Use better example for mixed-type operands (GH-1701) (#1856)
(cherry picked from commit e405d4b8df)
2017-05-29 18:19:31 -04:00
Mariatta 2ee91c8ad8 [3.6] bpo-30470: Deprecate invalid ctypes call protection on Windows. (GH-1810) (GH-1833)
Calling Ctypes functions is deprecated in 3.6.2 and will be removed in 3.7.
(cherry picked from commit f931fd1c2a)
2017-05-27 07:58:25 -07:00
Serhiy Storchaka b52c68a5a3 [3.6] bpo-30398: Add a docstring for re.error. (GH-1647) (#1830)
Also document that some attributes may be None.
(cherry picked from commit 12d6b5d)
2017-05-27 16:37:40 +03:00
Serhiy Storchaka 584ef2aecf [3.6] Fix the signature of JSONDecodeError (no end parameter). (GH-1827) (#1828)
Unlikely to the simplejson module, json.JSONDecodeError doesn't accept the end argument.
(cherry picked from commit 5becf38)
2017-05-27 16:37:11 +03:00
Zachary Ware a2a9984a27 [3.6] bpo-30160: Clarify intended usage of wfile (gh-1300) (GH-1793)
The library does not enforce compliance with the HTTP protocol,
so violations are not technically disallowed. Extend the stream's
description to avoid suggesting that intentional protocol violations are
not supported.
(cherry picked from commit a083c8e)
2017-05-24 16:11:01 -05:00
Kushal Das 9bcf81da14 [3.6] bpo-30376: Update outdated WindowObject references (GH-1630) (#1746)
(cherry picked from commit 93fc20b73e)
2017-05-23 09:57:04 -07:00
Mariatta 6ef0882303 [3.6] bpo-21056: Document return type of next method of csv reader (GH-146) (#1749)
(cherry picked from commit d618c8c6d3)
2017-05-22 22:27:02 -07:00
Mariatta 3d3b189f8e [3.6] bpo-30372: Clarify that '__builtins__' is a CPython Implementation detail (GH-1725) (GH-1727)
(cherry picked from commit 43c8a9e39b)
2017-05-22 14:36:19 -07:00
delirious-lettuce 0702cc01fa [3.6] Fix typos in multiple `.rst` files (GH-1668) (#1702)
(cherry picked from commit 3378b2062c)
2017-05-22 00:26:01 +03:00
Dominik Miedziński b769c91c2d Fix ModuleNotFoundError typo in import reference (#1610)
(cherry picked from commit c138d84b8d)
2017-05-17 09:17:55 +03:00
Berker Peksag 0d267041c4 bpo-29898: Fix incorrect env variable name (GH-1576)
It should read PYTHONLEGACYWINDOWSSTDIO as stated
in section "Add legacy mode" in PEP 528.

(cherry picked from commit 87fa8a780e)
2017-05-17 00:31:39 +03:00
Serhiy Storchaka 8fc1ff51ad [3.6] bpo-30380: Fix Sphinx 1.6.1 warnings. (GH-1613) (#1614)
* Use explicit numbering for footnotes referred by explicit number.
* Restore missed footnote reference in stdtypes.rst.
* Fix literal strings formatting in howto/urllib2.rst.
* Update susp-ignored.csv for zipapp.rst.
* Fix suspicious mark up in Misc/NEWS..
(cherry picked from commit d97b7dc94b)
2017-05-17 00:09:23 +03:00
Senthil Kumaran 75b8a54bca bpo-29651 - Cover edge case of square brackets in urllib docs (#1128) (#1596)
(cherry picked from commit f6e863d868)
2017-05-15 22:41:07 -07:00
Berker Peksag 61b6e5cf92 bpo-30358: Document sort argument of profile.runctx() (GH-1566)
(cherry picked from commit 9977629623)
2017-05-14 18:30:48 +03:00
Mariatta 3a66ab8695 [3.6] bpo-30178: Indent methods and attributes of MimeType class (GH-1306) (#1570)
(cherry picked from commit c71168090d)
2017-05-13 09:42:39 -07:00
Victor Stinner 9d02f56296 [3.6] bpo-23404: make touch becomes make regen-all (#1405) (#1461)
* bpo-23404: make touch becomes make regen-all (#1405)

Don't rebuild generated files based on file modification time
anymore, the action is now explicit. Replace "make touch"
with "make regen-all".

Changes:

* Remove "make touch", Tools/hg/hgtouch.py and .hgtouch
* Add a new "make regen-all" command to rebuild all generated files
* Add subcommands to only generate specific files:

  - regen-ast: Include/Python-ast.h and Python/Python-ast.c
  - regen-grammar: Include/graminit.h and Python/graminit.c
  - regen-importlib: Python/importlib_external.h and Python/importlib.h
  - regen-opcode: Include/opcode.h
  - regen-opcode-targets: Python/opcode_targets.h
  - regen-typeslots: Objects/typeslots.inc

* Rename PYTHON_FOR_GEN to PYTHON_FOR_REGEN
* pgen is now only built by by "make regen-grammar"
* Add $(srcdir)/ prefix to paths to source files to handle correctly
  compilation outside the source directory

Note: $(PYTHON_FOR_REGEN) is no more used nor needed by "make"
default target building Python.
(cherry picked from commit a5c62a8e9f)

* bpo-30273: Update sysconfig (#1464)

The AST_H_DIR variable was removed from Makefile.pre.in by the commit
a5c62a8e9f (bpo-23404).

AST_H_DIR was hardcoded to "Include", so replace the removed variable
by its content.

Remove also ASDLGEN variable from sysconfig example since this
variable was also removed.
(cherry picked from commit b109a1d336)
2017-05-05 00:46:56 +02:00
Mariatta af71364c3f [3.6] bpo-28315: Improve code examples in docs (GH-1372) (#1445)
Replace
   File "<stdin>", line 1, in ?
with
   File "<stdin>", line 1, in <module>
(cherry picked from commit 8856940cf2)
2017-05-03 18:41:20 -07:00
Mariatta 5bcf01d4cd [3.6] Fix typo in selectors.rst (GH-1383) (#1414)
decriptor -> descriptor
(cherry picked from commit b0d8203654)
2017-05-02 21:35:43 -07:00
Mariatta 78b23ab682 [3.6] Clean up some confusing text left by PROTOCOL_SSLv23 -> PROTOCOL_TLS transition (GH-1355) (#1371)
(cherry picked from commit d4069de511)
2017-05-01 22:55:53 -07:00
Mariatta 750ff5f8df [3.6] Improve the grammar in windows.rst (GH-1330) (GH-1360)
(cherry picked from commit 80a3da4d4a)
2017-04-29 22:18:40 -07:00
csabella 5a8dcec939 [3.6] bpo-30208: DOC: fix small typos in IDLE (#1356)
(cherry picked from commit d9af73330f)
2017-04-29 20:42:03 -04:00
Mariatta 33a5568f69 [3.6] bpo-30182: Use the correct name for ISO in Unicode HOWTO. (GH-1312) (GH-1313)
(cherry picked from commit 6fde770e4e)
2017-04-26 22:18:53 -07:00
Dong-hee Na 2fc3c543fc [3.6] bpo-30142: Remove "callable" from the 2to3fixer documentation. (GH-1303) 2017-04-26 09:55:55 -07:00
Berker Peksag 04f389b8b3 bpo-29974: Improve typing.TYPE_CHECKING example (GH-982)
* Fix PEP 8 (SomeType instead of some_type)
* Add a function parameter annotation
* Explain, using wording from PEP 484 and PEP 526,
  why one annotation is in quotes and another is not.

Suggested by Ivan Levkevskyi.

(cherry picked from commit 87c07fe9d9)
2017-04-26 17:25:37 +03:00
Louie Lu 9f6828119d bpo-28698: Fix c_wchar_p doc example (GH-1160)
(cherry picked from commit 0d637e236d)
2017-04-26 11:45:31 +03:00
Mariatta 16b6f971bd [3.6] bpo-28851: Improve namedtuple documentation (GH-1274) (GH-1286)
Clarify that a sequence of strings is the preferred value for 'field_names'.
(cherry picked from commit 97bf722fcd)
2017-04-25 18:23:05 -07:00
Mariatta ea0efa3bc1 [3.6] bpo-29751: Improve PyLong_FromString documentation (GH-915) (#1266)
(cherry picked from commit 26896f2832)
2017-04-23 21:05:01 -07:00
Serhiy Storchaka f2ed2858ee [3.6] bpo-15718: Document the upper bound constrain on the __len__ return value. (GH-1256) (#1259)
(cherry picked from commit 85157cd)
2017-04-23 08:50:14 +03:00
Louie Lu 9d022f169e [3.6] Fix trailing colon and newline in test.rst (GH-1250) (#1254)
(cherry picked from commit 7fae81e167)
2017-04-22 14:48:53 +03:00
Mariatta 414e0283a3 [3.6] Correct the README link in Unix install docs (GH-1245) (GH-1248)
(cherry picked from commit d1ae24e888)
2017-04-21 19:28:29 -07:00
Berker Peksag 83a90b9aed 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:42:32 +03:00
cocoatomo 5fb4bf91e7 bpo-19225: Remove duplicated description for standard warning categories (GH-1068) 2017-04-20 06:54:06 +03:00
Michael Seifert 05bfbcd233 [3.6] bpo-30059: Include Py_Ellipsis in C API documentation (GH-1018) (GH-1149) 2017-04-14 19:03:41 -07:00
Mariatta c5c24cfaf9 [3.6] Fix a typo in Doc/library/functions.rst (GH-1117) (GH-1123)
Replace `For object's ... ` with `For objects ...`
(cherry picked from commit 873ef20d00)
2017-04-13 16:37:51 -07:00
Serhiy Storchaka 9366332822 bpo-30021: Add examples for re.escape(). (#1048) (#1115)
And fix the parameter name.

(cherry picked from commit 8fc7bc2b76)
2017-04-13 19:41:19 +03:00
Berker Peksag 119d94ad37 bpo-29791: Clarify that flush is keyword-only argument (GH-1093)
Reported by Lucio Ricardo Montero Valenzuela.

(cherry picked from commit 61b9ac9371)
2017-04-13 16:17:01 +03:00
Xiang Zhang 14944c6230 bpo-26985: Add missing info of code object in inspect documentation (GH-1090) (GH-1099) 2017-04-13 11:14:17 +08:00
Mariatta f0c416799b [3.6] bpo-30047: Fix a typo in Doc/library/select.rst (GH-1086) (GH-1098)
(cherry picked from commit 3e0f1fc4e0)
2017-04-12 20:02:21 -07:00
Mariatta 28ddd3c905 [3.6] Improvements to typing documentation (GH-967) (GH-1053)
Documents a few omitted classes and adds NamedTuple methods.
(cherry picked from commit 45d22c256b)
2017-04-09 15:17:28 -07:00
Mariatta 90eb7a9ff4 [3.6] Correct typo in configparser.rst (GH-1012) (GH-1025)
(cherry picked from commit 01fa9ae546)
2017-04-09 15:15:57 -07:00
Nick Coghlan a524d63072 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.
(cherry picked from commit 19e0494256)
2017-04-09 20:57:04 +10:00
Barry Warsaw 616d3eb7ef Fix a minor typo. (#1032) (#1037)
(cherry picked from commit dd9a0a14c8)
2017-04-07 16:50:13 -04:00
Senthil Kumaran cb1e002c07 bpo-29725: DOC: add text for arraysize in sqlite3.Cursor (#947) (#985)
(cherry picked from commit 02e1213800)
2017-04-03 22:27:15 -07:00
cocoatomo d184c20e35 Keep the c-api exception doc up-to-date (#966)
cherry-pick'ed from ec1f5df..e3d6db3
2017-04-03 19:26:32 +03:00
Senthil Kumaran a71a3ad54d bpo-26947: DOC: clarify wording on hashable in glossary (#948) (#957)
(cherry picked from commit 64c887ab3a)
2017-04-01 20:00:36 -07:00
INADA Naoki 4c75fbb485 bpo-29952: Use usual terminology of dict (GH-922)
s/keys and elements/keys and values/
(cherry picked from commit cdcac039fb)
2017-03-31 15:43:10 +09:00
Mariatta 7b5b1379ac bpo-29928: Add f-string to the Glossary (GH-864) (GH-914)
(cherry picked from commit 33db068dac)
2017-03-30 12:27:19 -07:00
Senthil Kumaran da6ad2f780 bpo-29917: DOC: Remove link from PyMethodDef (#890) (#894)
(cherry picked from commit c3c7ef0885)
2017-03-29 22:29:00 -07:00
Mariatta 2609c9ee78 bpo-29677: DOC: clarify documentation for `round` (GH-877) (GH-892)
(cherry picked from commit 85deefcf61)
2017-03-29 19:10:07 -07:00
Mariatta c4021af505 bpo-16011: clarify that 'in' always returns a boolean value (GH-874)
(cherry picked from commit 0ae7c8bd61)
2017-03-28 09:33:54 -07:00
Mariatta 5965062161 bpo-29677: DOC: clarify documentation for `round` (GH-357) (GH-862)
(cherry picked from commit 6003db7db5)
2017-03-27 17:02:29 -07:00
Zachary Ware abc68484b2 Treat Sphinx warnings as errors (GH-832) (GH-834)
* Treat Sphinx warnings as errors (GH-832)

(cherry picked from commit 334e9ec938)

* Remove unused suspicious rules
2017-03-26 22:53:57 -05:00
Ned Deily ceff32fb83 bpo-29888: Fix the link referring to the "Python download page" (GH-824) (GH-826)
(cherry picked from commit f8beb9831a)
2017-03-26 13:58:13 -04:00
Mariatta 5dafaece67 bpo-29892: Fix wrong markup on doc-lib-functions (GH-802) (GH-810)
(cherry picked from commit 29540cdf6c)
2017-03-24 20:04:40 -07:00
Brett Cannon 74bfcc314b bpo-28810: Document remaining bytecode changes in 3.6 (GH-651) (GH-808)
(cherry picked from commit 8f9e1bbf2d)
2017-03-24 14:18:53 -07:00
Mariatta ee51327a23 Remove an outdated statement in execution model docs (GH-754) (GH-775)
(cherry picked from commit fad7f15606)
2017-03-22 18:56:56 -07:00
INADA Naoki 906118d8c6 bpo-28331: fix impl-detail label is removed when content is translated. (GH-769)
(cherry picked from commit c351ce6a2c)
2017-03-22 21:09:41 +09:00
INADA Naoki c0f3e21a23 doc: minor fix for library/profile (GH-766)
(cherry picked from commit bd3d8ba3b2)
2017-03-22 17:14:03 +09:00
Xiang Zhang 72c51136c6 fix function name in tabnanny documentation (GH-762) 2017-03-22 15:26:53 +08:00
Serhiy Storchaka fcd79ada4e Fix "NotImplentedError" typo in constants documentation (#692) (#739)
`NotImplentedError` --> `NotImplementedError`
(cherry picked from commit 05f53735c8)
2017-03-20 14:54:52 +02:00
Mariatta d1f566f6bd bpo-29856: Fix typo in curses documentation (GH-730) (GH-731)
From Shifted Dxit -> Shifted Exit in Doc/library/curses.rst
(cherry picked from commit 64508780d7)
2017-03-19 20:55:16 -07:00
Serhiy Storchaka 69eab3123e bpo-28749: Fixed the documentation of the mapping codec APIs. (#487) (#714)
Added the documentation for PyUnicode_Translate().
(cherry picked from commit c85a26628c)
2017-03-19 20:26:26 +02:00
Berker Peksag 948171bf99 bpo-16355: Clarify when inspect.getcomments() returns None (#428) (#690)
Initial patch by Vajrasky Kok.

(cherry picked from commit 3f2155ffe6)
2017-03-17 14:59:16 +03:00
Mariatta 3fce38c540 bpo-29820: othergui.rst: Remove outdated information (GH-685) (GH-688)
(cherry picked from commit 1bb0f3762e)
2017-03-16 19:56:56 -07:00
Xiang Zhang 388e2568fc ftplib.FTP.retrbinary callback gets a bytes, not a str (GH-652) (GH-657) 2017-03-13 11:03:36 +08:00
Xiang Zhang 7927abba34 fix the name of argument to ftplib.FTP.set_pasv and fix wording (GH-653) (GH-654) 2017-03-13 10:36:34 +08:00
Serhiy Storchaka 4652d82a51 bpo-29746: Update marshal docs to Python 3. (#547) (#631)
(cherry picked from commit c611a5b1d4)
2017-03-12 10:05:05 +02:00
Mariatta d7a8d32ce2 tempfile.rst: Fix some typos (GH-610) (GH-618)
(cherry picked from commit d3b8f98696)
2017-03-11 10:19:51 -08:00
Xiang Zhang 16416c22f9 bpo-29770: remove outdated PYO related info (GH-590) (GH-612) 2017-03-11 14:07:30 +08:00
Mariatta 701f13ab93 bpo-29784: Fix the reference to shutil.copy in the docs (GH-602) (GH-608)
(cherry picked from commit 70ee0cd5c2)
2017-03-10 19:36:26 -08:00
Brett Cannon 4807fa8386 bpo-28810: Document changes to CALL_FUNCTION opcodes (GH-607)
(cherry picked from commit 4b2a2a425a)
2017-03-10 15:08:52 -08:00
Brett Cannon 68c5e4c592 bpo-28810: Document BUILD_TUPLE_UNPACK_WITH_CALL bytecode (GH-605)
(cherry picked from commit 7e52c3e7ae)
2017-03-10 14:44:48 -08:00
Mariatta ff6f371627 bpo-28739: Document that f-strings cannot be used as docstring (GH-592) (GH-600)
(cherry picked from commit d4e89287b3)
2017-03-10 09:52:03 -08:00
Serhiy Storchaka eb65edd102 [3.6] bpo-28231: The zipfile module now accepts path-like objects for external paths. (#561)
(cherry picked from commit 8606e9524a)
2017-03-08 15:45:43 +02:00
Serhiy Storchaka 666165fddf [3.6] bpo-28230: Document the pathlib support in tarfile and add tests. (#559) 2017-03-08 12:29:33 +02:00
Mariatta 130c4ec5fb bpo-29557: Remove ambiguous line in binhex docs (GH-90) (GH-475)
"appears to not work in all cases" does not inspire confidence in this
module. I can find no context for what bug this was referencing so it
should be removed.
(cherry picked from commit 6de2b7817f)
2017-03-06 09:31:16 -08:00
Mariatta e9effe6bb6 fix minor bug in pymalloc. (GH-335) (GH-476)
(cherry picked from commit f669ffff60)
2017-03-06 09:15:41 -08:00
INADA Naoki 4e1a065c20 bpo-29719: Remove Date and Release field in whatsnew/3.6 (GH-500)
(cherry picked from commit 2225ddaa9e)
2017-03-06 17:24:28 +09:00
Mariatta 9619ec9947 distutils docs: Fix a typo (GH-470) (GH-471)
(cherry picked from commit 2a7bddaab7)
2017-03-04 16:43:57 -08:00
Mariatta 43571dde7b Correct spelling "instanciate" (GH-465) (GH-467)
(cherry picked from commit 6abaed0dda)
2017-03-04 15:40:48 -08:00
Brett Cannon 226af23e85 bpo-26213: Document _UNPACK bytecodes and BUILD_MAP changes (GH-440)
(cherry picked from commit 0705f66eb3)
2017-03-03 14:47:06 -08:00
Mariatta 1936ba93c9 bpo-29709: Improve Boolean Operations documentation (#433) (#437)
(cherry picked from commit 8eb531d9db)
2017-03-03 13:24:13 -08:00
Brett Cannon 9d07aceeda bpo-29455: Mention coverage.py in trace module documentation (GH-435)
(cherry picked from commit 5dfccb06dc)
2017-03-03 12:58:17 -08:00