Commit graph

8367 commits

Author SHA1 Message Date
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
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
Łukasz Rogalski
ea9cbe0a5c Doc that 'sorted' args are keyword-only, fix 'reverse' default (#2709)
backport
2017-07-14 15:57:19 -04: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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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