Mariatta
7333d1760e
bpo-29648: import.rst: Add reference to create_module() (GH-290) (GH-314)
...
(cherry picked from commit 46ce7599af
)
2017-02-26 07:33:54 -08:00
Mariatta
b00232842c
Fix small typos in introduction and datastructures of tutorial (GH-272) (GH-297)
...
(cherry picked from commit 53c1892dc3
)
2017-02-25 22:34:51 -08:00
Mariatta
814213bdf1
[3.6] Backport README.rst changes (GH-294)
...
(cherry picked from commit b3f1f59cf4
)
(cherry picked from commit 1b3d88eb33
)
(cherry picked from commit c0866855d5
)
(cherry picked from commit e32ec9334b
)
(cherry picked from commit 6329aea78e
)
2017-02-25 11:56:48 -08:00
Mariatta
f28db60179
[3.6] Fix small typos in expressions.rst (GH-276) (GH-281)
...
(cherry picked from commit 132ac381fe
)
2017-02-24 16:39:30 -08:00
Barry Warsaw
0a1b656d8c
bpo-25008: Deprecate smtpd and point to aiosmtpd ( #274 ) ( #278 )
2017-02-24 15:44:34 -05:00
Berker Peksag
2197eac610
bpo-28814: Undeprecate inadvertently deprecated inspect functions. ( #122 ) ( #243 )
...
Nick Coghlan said on bpo-28814:
> inspect.getargvalues() and inspect.formatargvalues() were deprecated
> in Python 3.5 as part of implementing bpo-20438
> This is incorrect, as these are *frame* introspection related functions,
> not callable introspection ones. The documentation and implementation
> layout is confusing though, as they're interleaved with the callable
> introspection operation
This commit undeprecates these functions and adds a note to ignore
previous deprecation notices.
(cherry picked from commit 0899b98095
)
2017-02-24 01:42:30 +10:00
Arne de Laat
55b82e10dc
bpo-28911: Clarify the behaviour of assert_called_once_with. ( #252 )
...
(cherry picked from commit 9d56b34af2
)
2017-02-23 16:17:11 +01:00
Berker Peksag
b067a5eef7
bpo-29554: Improve docs for pstat module and profile. ( #88 ) ( #227 )
...
Clarify that methods take a string which is interpreted as a regex,
not a regex object.
Also clarify what the old `-1`, `0`, `1` and `2` options were.
(cherry picked from commit 8fb1f6e039
)
2017-02-22 04:55:33 +03:00
Mariatta
9b49133082
bpo-29453: Remove reference to undefined dictionary ordering in Tutorial (GH-140) ( #208 )
...
As of Python 3.6 **kwargs are ordered, thus, remove the paragraph stating that
ordering is undefined and change snippet to remove the unecessary sorted call.
* Add sentence mentioning guaranteed output order of kwargs
(cherry picked from commit 32e8f9bdfd
)
2017-02-21 10:30:07 -08:00
INADA Naoki
51a477c0d5
doc: fix compile error on "shoddy" example extension (GH-216)
...
(cherry picked from commit fb8fe72fc5
)
2017-02-21 23:56:26 +09:00
Senthil Kumaran
a4afdfcf27
Change some mercurial/ hg.python.org references. ( #8 ) ( #185 )
...
(cherry picked from commit b2ee40ed9c
)
2017-02-19 18:58:33 -08:00
INADA Naoki
7970cd4833
bpo-29520: doc: fix deprecation warning from 'defindex' template (GH-178)
2017-02-20 09:46:46 +09:00
Berker Peksag
b121d737fe
Tweak PEP 519 documentation in stdlib ( #164 )
...
* Drop duplicate word 'object' in lzma docs
* Fix typo in os docs: fpr -> for
(cherry picked from commit d4d48743ac
)
2017-02-19 14:40:55 +03:00
Victor Stinner
b300c660d3
Backport36 doc fixes: PR#68 and PR#124 ( #125 )
...
* Travis CI: run rstlint.py in the docs job (#68 )
Currently, http://buildbot.python.org/all/buildslaves/ware-docs
buildbot is only run as post-commit. For example, bpo-29521 (PR#41)
introduced two warnings, unnotified by the Travis CI docs job.
Modify the docs job to run toosl/rstlint.py.
Fix also the two minor warnings which causes the buildbot slave to
fail.
(cherry picked from commit 2b501866ed
)
* Doc/Makefile: set PYTHON to python3 (#124 )
rstlint.py run by "make check" doesn't support Python 2.
"make venv" runs "$(PYTHON) -m venv", whereas Python 2 doens't
provide the venv module: it's a module of Python 3 standard library.
(cherry picked from commit 91b0e7d0ca
)
2017-02-16 00:56:54 +01:00
Mariatta
7224a049b8
bpo-29481: add versionadded 3.6.1 to typing.Deque docs ( #108 )
...
(cherry picked from commit 7e147f1ddb
)
2017-02-15 11:38:48 -08:00
Mariatta
db3deb98e9
bpo-29521 Fix two minor documentation build warnings ( #41 ) ( #83 )
...
Much of bpo-29521 was fixed in parallel with commit
e7ffb99
. This cleans up the rest.
Apply parallel change to Doc/make.bat to read
"set SPHINXOPTS=-D latex_elements.papersize="
I don't have a Windows system on which to observe the warning,
but it should be necessary.
The warning:
.../workspace/cpython_github/Doc/faq/windows.rst:303:
WARNING: unknown option: -t
In the Windows FAQ, `How do I keep editors from inserting tabs
into my Python source?`, contained a reference to a Python -t
option. In Python 2.x, this caused Python to issue warnings
about lines with mixed spaces and tabs, but as of Python 3.6
it does nothing.
Per discussion at http://bugs.python.org/issue29387 , take
their wording. Python [3] raises an IndentationError or
TabError. Tabnanny is now a module.
(cherry picked from commit 3d707be950
)
2017-02-14 08:54:59 -08:00
Mariatta
9268855ba6
Fix some sphinx warnings ( #9 ) ( #81 )
...
* Fix some deprecation warnings in Doc/conf.py
* Fix an rst error in Misc/NEWS
Contributed by Ryan Gonzalez @kirbyfan64
(cherry picked from commit e7ffb99f84
)
2017-02-14 06:11:48 -08:00
Mariatta
f66c81ff49
[backport to 3.6] bpo-28929: Link the documentation to its source file on GitHub ( #37 )
...
* bpo-28929: Link the documentation to its source file on GitHub
Change the documentation's `Show Source` link on the left menu
to GitHub source file.
(cherry picked from commit 23bafa294c
)
* remove if statement
2017-02-12 13:08:24 -08:00
Mariatta
308f789d00
bpo-29474: Improve documentation for weakref.WeakValueDictionary ( #22 )
...
There were some grammatical errors in weakref.WeakValueDictionary
documentation.
2017-02-12 08:18:07 -08:00
Mariatta
c2328ec0f4
[backport to 3.6] Support "bpo-" in Misc/NEWS ( #42 )
...
(cherry picked from commit 79ab8be05f
)
2017-02-12 15:18:45 +03:00
Benjamin Peterson
35a1f7f62d
massage English for -X descriptions a bit
2017-02-09 22:31:17 -08:00
Nick Coghlan
e1857579f8
Merge issue #26355 fix from Python 3.5
2017-02-09 16:08:17 +01:00
Nick Coghlan
e66244521c
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 16:03:59 +01:00
Berker Peksag
088507644e
Issue #29441 : Merge from 3.5
2017-02-07 11:27:48 +03:00
Berker Peksag
f59286794b
Issue #29441 : Update examples to use async and await keywords in asyncio-task.rst
2017-02-07 11:27:09 +03:00
Mariatta Wijaya
e39262ccc3
Issue #29371 : merge with 3.5
2017-02-06 20:16:58 -08:00
Mariatta Wijaya
81b8977349
Issue #29371 : Clarify bitwise OR operation in doctest option flags.
2017-02-06 20:15:01 -08:00
Raymond Hettinger
d0b9158666
Substitute a more readable f-string
2017-02-06 07:15:31 -08:00
Berker Peksag
d93c4de522
Fix usage of data directive
2017-02-06 13:37:19 +03:00
Berker Peksag
5a001eea5b
Issue #29198 : Merge from 3.5
2017-02-04 09:34:48 +03:00
Berker Peksag
5702fb7b4d
Issue #29198 : Fix indentation and markup in typing.rst
...
Patch by Jelle Zijlstra.
2017-02-04 09:34:16 +03:00
Berker Peksag
14169b2a89
Issue #29198 : Merge from 3.5
2017-02-04 09:18:42 +03:00
Berker Peksag
38962a6fe2
Issue #29198 : Document typing.AsyncGenerator
...
Patch by Jelle Zijlstra.
2017-02-04 09:18:11 +03:00
Mariatta Wijaya
23dcccb75b
Issue #29381 : Clarify ordering of UNIX shebang line as source encoding line
2017-02-01 20:55:47 -08:00
Mariatta Wijaya
77bb0f4900
Backed out changeset 3d712292f2fa
2017-02-01 20:38:55 -08:00
Mariatta Wijaya
e2d8bc52c4
Issue #29381 : Clarify ordering of UNIX shebang line as source encoding line
2017-02-01 20:21:22 -08:00
Berker Peksag
c6fe419d1b
Issue #29407 : Merge from 3.5
2017-02-01 22:37:49 +03:00
Berker Peksag
d5adb63673
Issue #29407 : Remove redundant ensure_future() calls in factorial example
2017-02-01 22:37:16 +03:00
Martin Panter
e334a53343
Issues #11670 : Merge configparser doc from 3.5
2017-01-29 23:36:39 +00:00
Martin Panter
b154113251
Issues #29349 : Merge Py 2.6+ compatibility from 3.5
2017-01-29 23:34:52 +00:00
Martin Panter
1f10671fc8
Issue #11670 : readfp(fp) parameter name is different to read_file(f)
2017-01-29 23:33:27 +00:00
Martin Panter
9a454021a4
Issue #29349 : Use __future__ print_function; Sphinx may use Python 2.6+
2017-01-29 23:33:13 +00:00
Martin Panter
e61592e7e1
Issues #29349 : Merge Py 2 fix 3.5
2017-01-29 10:09:43 +00:00
Martin Panter
2be9889405
Issues #12067 : Merge hash recommendation from 3.5
2017-01-29 10:07:26 +00:00
Martin Panter
8f3fb72309
Issue #29349 : Fix Python 2 syntax in documentation build code
2017-01-29 10:05:02 +00:00
Martin Panter
8dbb0ca573
Issue #12067 : Recommend that hash and equality be consistent
2017-01-29 10:00:23 +00:00
Raymond Hettinger
e53bd8e2d0
Issue 29310: Document typing.NamedTuple default argument syntax
2017-01-28 20:16:40 -08:00
Vinay Sajip
dc4ce0e013
Fixes #28784 : Clarified use of shlex.shlex with punctuation_chars.
2017-01-27 13:04:33 +00:00
Senthil Kumaran
b0d0e19dd5
issue26149 - Point to Wiki for Editors and Python IDEs on Unix.
...
Patch contributed by Mariatta Wijaya.
2017-01-25 01:47:49 -08:00
Martin Panter
574ff0680f
Issues #29189 : Merge indentation fixes from 3.5
2017-01-24 00:29:11 +00:00
Martin Panter
ef107ee7a0
Issue #29189 : Fix indentation in RST markup
2017-01-24 00:26:56 +00:00
Victor Stinner
01f5ae7b76
Issue #26273 : Document TCP_USER_TIMEOUT and TCP_CONGESTION
2017-01-23 12:30:00 +01:00
Xiang Zhang
4459e009ed
Issue #29092 : Sync os.stat's doc and docstring on path type.
2017-01-22 13:04:17 +08:00
Xiang Zhang
d7d87ca9b0
Issue #29092 : Sync os.stat's doc and docstring on path type.
2017-01-22 12:54:44 +08:00
Ned Deily
67c1cb2008
Issue #29316 : Restore the provisional status of typing module and add
...
corresponding note to documentation. Patch by Ivan L.
2017-01-20 10:13:23 -05:00
Raymond Hettinger
a57a8a3e2d
Issue #29281 : Fill-in a missing versionchanged entry
2017-01-19 21:39:37 -08:00
Xiang Zhang
346454c7f5
Issue #29292 : Merge 3.5.
2017-01-20 11:29:48 +08:00
Xiang Zhang
6ad85bf89a
Issue #29292 : Update outdated doc of PyEval_EvalCodeEx.
...
Patch by Ammar Askar.
2017-01-20 11:29:11 +08:00
Martin Panter
4710935b11
Issue 29274: Merge doc fixes from 3.5
2017-01-18 12:11:12 +00:00
Martin Panter
37f183d43d
Issue #29274 : tests cases → test cases
2017-01-18 12:06:38 +00:00
Raymond Hettinger
e12c313f5e
merge
2017-01-16 22:43:43 -08:00
Raymond Hettinger
80490525e0
Issue #29011 : Fix an important omission by adding Deque to the typing module.
2017-01-16 22:42:37 -08:00
INADA Naoki
2e1b6ea4b7
Issue #29062 : Doc: Fix make suspicious
2017-01-14 21:04:21 +09:00
Martin Panter
4659ddc433
Merge doc fixes from 3.5
2017-01-14 09:54:57 +00:00
Martin Panter
8f1378366e
Avoid line breaks after hyphens, otherwise they are turned into spaces
2017-01-14 08:24:20 +00:00
Martin Panter
536d70ed33
Fix grammar, typos and markup in documentation and code comments
...
* Indent versionchanged at method level, not class level
* 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:23:08 +00:00
INADA Naoki
e2f9e77df2
Issue #29062 : Merge hashlib-blake2.rst into hashlib.rst
2017-01-13 19:29:58 +09:00
Serhiy Storchaka
3159b33a95
Merge with 3.5.
2017-01-11 20:17:34 +02:00
Serhiy Storchaka
87006a3d4a
Issue #20804 : Document the limitation of the unittest.mock.sentinel attributes.
2017-01-11 20:16:44 +02:00
Martin Panter
ced4b90756
Issue #29239 : Fix --enable-optimizations bug number
2017-01-11 11:56:22 +00:00
Martin Panter
a27b3b3192
Issue #15657 : Merge other doc fix from 3.5
2017-01-11 11:51:02 +00:00
Martin Panter
5b66723b0b
Issue #15657 : Delete incorrect statement from PyMethodDef documentation
...
Patch by Berker Peksag.
2017-01-11 11:50:06 +00:00
Martin Panter
9da31f7274
Issue #15657 : METH_KEYWORDS cannot be used alone in Python 3
2017-01-11 11:41:03 +00:00
Xiang Zhang
2427d00298
Issue #29217 : Merge 3.5.
2017-01-10 11:30:02 +08:00
Xiang Zhang
8a17995589
Issue #29217 : Fix the wrong type description of UUID.variant.
2017-01-10 11:29:27 +08:00
Vinay Sajip
aa655b3a8e
Fixes #29133 : clarified shlex documentation.
2017-01-09 16:46:04 +00:00
Raymond Hettinger
d15bb26248
Update OrderedDict docs to reflect acceptance of PEP 468
2017-01-07 22:05:12 -08:00
Berker Peksag
631ada8424
Issue #16026 : Fix parameter names of DictReader and DictWriter
...
CPython and PyPy use f as the name of the first parameter of
DictReader and DictWriter classes.
Patch by James Salt and Greg Bengeult.
2017-01-07 09:32:56 +03:00
Berker Peksag
406c252970
Issue #29012 : Merge from 3.5
2017-01-03 03:35:49 +03:00
Berker Peksag
7b4e551091
Issue #29012 : Remove another outdated information
...
Patch by Jim Fasarakis-Hilliard.
2017-01-03 03:34:15 +03:00
Benjamin Peterson
5848e72ee1
merge 3.5
2017-01-01 22:08:44 -06:00
Benjamin Peterson
4365833d11
merge 3.4
2017-01-01 22:08:33 -06:00
Benjamin Peterson
b6e2142b0c
merge 3.3
2017-01-01 22:07:37 -06:00
Benjamin Peterson
e527dd34bc
ring in 2017 for Python
2017-01-01 22:04:13 -06:00
Berker Peksag
5430293fdf
Issue #29013 : Merge from 3.5
2017-01-02 06:14:12 +03:00
Berker Peksag
4950ae1491
Issue #29013 : Fix allowZip64 documentation
...
Zip files can be larger than 4 GiB if allowZip64
is true (default since Python 3.4)
2017-01-02 06:13:42 +03:00
Berker Peksag
a22457ecaf
Issue #29012 : Merge from 3.5
2017-01-02 06:01:07 +03:00
Berker Peksag
14adafd6ee
Issue #29012 : Remove outdated information about __bases__
...
Patch by Jim Fasarakis-Hilliard.
2017-01-02 06:00:35 +03:00
Berker Peksag
2a267a12ee
Issue #29129 : Fix typo in "Using auto" section
2017-01-02 05:51:04 +03:00
Berker Peksag
37023b64d7
Issue #29024 : Merge from 3.5
2017-01-02 05:45:16 +03:00
Berker Peksag
d2d673fc4c
Issue #29024 : Add Kivy entry to GUI FAQ
...
Patch by inclement.
2017-01-02 05:44:49 +03:00
Berker Peksag
9db22dd968
Issue #26267 : Merge from 3.5
2016-12-31 20:08:53 +03:00
Berker Peksag
6b5e4a86a7
Issue #26267 : Improve uuid.UUID documentation
...
* Document how comparison of UUID objects work
* Document str(uuid) returns the braceless standard form
* Add a test for comparison of a UUID object with a non-UUID object
Patch by Ammar Askar.
2016-12-31 20:08:16 +03:00
Vinay Sajip
53a21eb479
Closes #29105 : Updated RotatingFileHandler documentation.
2016-12-31 11:06:57 +00:00
Raymond Hettinger
51447db47c
Clearer compact dict attribution to the original proposal
2016-12-29 23:49:20 -07:00
Xiang Zhang
9ea82ddad5
Issue #29112 : Merge 3.5.
2016-12-30 11:57:40 +08:00
Xiang Zhang
cea904f286
Issue #29112 : Fix a questionable wording in sequence doc.
2016-12-30 11:57:09 +08:00
Victor Stinner
771cf898f4
Merge 3.5
2016-12-30 02:15:29 +01:00
Victor Stinner
440d70301b
Issue #29109 : Enhance tracemalloc documentation
...
* Wrong parameter name, 'group_by' instead of 'key_type'
* Don't round up numbers when explaining the examples. If they exactly match
what can be read in the script output, it is to easier to understand
(4.8 MiB vs 4855 KiB)
* Fix incorrect method link that was pointing to another module
Patch written by Loic Pefferkorn.
2016-12-30 02:14:59 +01:00
Serhiy Storchaka
44223e9550
Issue #29087 : Removed the documentation of non-existing UCS4 support functions.
2016-12-28 09:19:45 +02:00