Commit Graph

20208 Commits

Author SHA1 Message Date
Mariatta bc10e6bd7b Asyncio documentation: remove `self` from method signatures (GH-334) (GH-337)
(cherry picked from commit 091b84f23a)
2017-02-27 06:02:21 -08:00
Xiang Zhang 8aa1ad892f bpo-29662: fix wrong indentation in timeit.Timer's doc (GH-333) 2017-02-27 13:55:07 +08:00
Mariatta 7e4897a2fb bpo-26184: import.rst: Improve versionchanged note (GH-325) (GH-326)
(cherry picked from commit 1f5639c77f)
2017-02-26 13:30:44 -08:00
Berker Peksag 6b81003bdb bpo-28624: Add a test that checks that cwd parameter of Popen() accepts PathLike objects (#157) (#323)
(cherry picked from commit d5c11f7ace)
2017-02-26 20:38:31 +03:00
Mariatta deea29e61e bpo-26184: import.rst: Improve versionchanged note (GH-277) (#320)
(cherry picked from commit 6b4a5f45e2)
2017-02-26 08:55:23 -08:00
Berker Peksag 893e86e9d3 bpo-29121: Remove outdated documentation about transactions (#313) (#319)
Patch by Aviv Palivoda.

(cherry picked from commit fe70d924bb)
2017-02-26 19:04:00 +03:00
Mariatta 1457984c00 bpo-22594: Add a link to the regex module in re documentation (GH-241) (GH-316)
(cherry picked from commit ed6795e46f)
2017-02-26 07:44:16 -08:00
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