Commit graph

18957 commits

Author SHA1 Message Date
Serhiy Storchaka
f12f820ef8 bpo-29746: Update marshal docs to Python 3. (#547) (#630)
(cherry picked from commit c611a5b1d4)
2017-03-12 10:05:27 +02:00
Mariatta
5f63884b72 tempfile.rst: Fix some typos (GH-610) (GH-619)
(cherry picked from commit d3b8f98696)
2017-03-11 10:19:37 -08:00
Xiang Zhang
ce222c8770 bpo-29770: remove outdated PYO related info (GH-590) (GH-613) 2017-03-11 14:12:29 +08:00
Mariatta
518d8fcb89 bpo-29784: Fix the reference to shutil.copy in the docs (GH-602) (GH-609)
(cherry picked from commit 70ee0cd5c2)
2017-03-10 19:36:52 -08:00
Mariatta
6b7bc45e33 bpo-29557: Remove ambiguous line in binhex docs (GH-90) (GH-474)
"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:00 -08:00
Mariatta
171b674c8b distutils docs: Fix a typo (GH-470) (#472)
(cherry picked from commit 2a7bddaab7)
2017-03-04 16:44:30 -08:00
Mariatta
5789e415e8 Correct spelling "instanciate" (GH-465) (GH-468)
(cherry picked from commit 6abaed0dda)
2017-03-04 15:40:36 -08:00
Brett Cannon
4d0630d9d5 bpo-26213: Document _UNPACK bytecodes and BUILD_MAP changes (GH-441)
(cherry picked from commit 0705f66eb3)
2017-03-03 14:47:22 -08:00
Mariatta
6e965d9e78 bpo-29709: Improve Boolean Operations documentation (#433) (#436)
(cherry picked from commit 8eb531d9db)
2017-03-03 13:23:55 -08:00
Berker Peksag
d0620bcd4e Add Python version since deprecation in base64 methods. (#33) (#430)
Allow developers to not have to either test on N Python versions or
looked through multiple versions of the docs to know whether they can
easily update.

(cherry picked from commit c643a967dd)
2017-03-03 18:07:01 +03:00
Mariatta
8c851fa3d3 bpo-29026: Clarify documentation of time.time (GH-34) (GH-418)
(cherry picked from commit 23557d59b8)
2017-03-02 21:50:46 -08:00
Mariatta
b945e0784f Asyncio documentation: remove self from method signatures (GH-334) (GH-336)
(cherry picked from commit 091b84f23a)
2017-02-27 06:01:59 -08:00
Mariatta
21c697fd10 bpo-22594: Add a link to the regex module in re documentation (GH-241) (GH-317)
(cherry picked from commit ed6795e46f)
2017-02-26 07:44:36 -08:00
Mariatta
63ed9bc94d bpo-29648: import.rst: Add reference to create_module() (GH-290) (GH-315)
(cherry picked from commit 46ce7599af)
2017-02-26 07:40:03 -08:00
Mariatta
4c784632f7 [3.5] Fix small typos in introduction and datastructures of tutorial (GH-272) (GH-299)
(cherry picked from commit 5bd5b9d813)
(cherry picked from commit 8c5e190d36)
(cherry picked from commit 53c1892dc3)
2017-02-25 22:35:39 -08:00
Barry Warsaw
66b5092fac bpo-25008: Deprecate smtpd and point to aiosmtpd (#274) (#279) 2017-02-24 16:15:17 -05:00
Arne de Laat
fa30453568 bpo-28911: Clarify the behaviour of assert_called_once_with. (#254)
(cherry picked from commit 9d56b34af2)
2017-02-23 17:16:56 +01:00
Berker Peksag
0246422b97 bpo-28814: Undeprecate inadvertently deprecated inspect functions. (#122) (#244)
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:45:57 +10:00
Berker Peksag
6336f0d156 bpo-29554: Improve docs for pstat module and profile. (#88) (#228)
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:03 +03:00
INADA Naoki
9ab8eaf965 doc: fix compile error on "shoddy" example extension (GH-217)
(cherry picked from commit fb8fe72fc5)
2017-02-21 23:55:49 +09:00
Senthil Kumaran
314a86bae2 Change some mercurial/ hg.python.org references. (#8) (#184)
(cherry picked from commit b2ee40ed9c)
2017-02-19 18:58:20 -08:00
INADA Naoki
f0174c69b7 bpo-29520: doc: fix deprecation warning from 'defindex' template (GH-179) 2017-02-20 09:46:24 +09:00
Victor Stinner
5e04dfecec Backport35 doc fixes: PR#68 and PR#124 (#125) (#126)
* 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)
(cherry picked from commit b300c660d3)
2017-02-16 10:43:16 +01:00
Mariatta
bb53a27a5d [cherry-pick for 3.5] bpo-29481: add versionadded 3.5.4 to typing.Deque docs (#109)
(cherry picked from commit 7e147f1ddb)
2017-02-15 11:39:37 -08:00
Mariatta
38c8354f32 bpo-29521 Fix two minor documentation build warnings (#41) (#84)
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:22 -08:00
Mariatta
c0f9014a51 Fix some sphinx warnings (#9) (#82)
* 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:12:15 -08:00
Mariatta
af456b241b Support "bpo-" in Misc/NEWS (#1) (#43)
Change the url to 3.5

(cherry picked from commit 79ab8be05f)

Contributed by Brett Cannon
2017-02-13 12:11:25 -08:00
Mariatta
cabd1c7462 [backport to 3.5] bpo-28929: Link the documentation to its source file on GitHub (#36)
* 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:00 -08:00
Mariatta
ae828714eb bpo-29474: Improve documentation for weakref.WeakValueDictionary (#23)
There were some grammatical errors in weakref.WeakValueDictionary
documentation.
2017-02-12 08:21:36 -08: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
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
81b8977349 Issue #29371: Clarify bitwise OR operation in doctest option flags. 2017-02-06 20:15:01 -08: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
38962a6fe2 Issue #29198: Document typing.AsyncGenerator
Patch by Jelle Zijlstra.
2017-02-04 09:18:11 +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
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
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
Martin Panter
ef107ee7a0 Issue #29189: Fix indentation in RST markup 2017-01-24 00:26:56 +00:00
Xiang Zhang
d7d87ca9b0 Issue #29092: Sync os.stat's doc and docstring on path type. 2017-01-22 12:54:44 +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
37f183d43d Issue #29274: tests cases → test cases 2017-01-18 12:06:38 +00: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
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
Serhiy Storchaka
87006a3d4a Issue #20804: Document the limitation of the unittest.mock.sentinel attributes. 2017-01-11 20:16:44 +02: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
8a17995589 Issue #29217: Fix the wrong type description of UUID.variant. 2017-01-10 11:29:27 +08:00
Berker Peksag
7b4e551091 Issue #29012: Remove another outdated information
Patch by Jim Fasarakis-Hilliard.
2017-01-03 03:34:15 +03:00