Commit graph

20310 commits

Author SHA1 Message Date
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