Commit graph

18937 commits

Author SHA1 Message Date
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
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
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
14adafd6ee Issue #29012: Remove outdated information about __bases__
Patch by Jim Fasarakis-Hilliard.
2017-01-02 06:00:35 +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
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
Xiang Zhang
cea904f286 Issue #29112: Fix a questionable wording in sequence doc. 2016-12-30 11:57:09 +08: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
af9181a4f2 Issue #29087: Removed the documentation of non-existing UCS4 support functions. 2016-12-28 09:19:15 +02:00
Berker Peksag
1fee5151f7 Issue #29069: Update the default URL of PyPI server
Patch by paka.
2016-12-27 15:16:25 +03:00
Berker Peksag
8e2bdc8fe8 Move versionadded inside of the get_terminal_size() block 2016-12-27 15:09:11 +03:00
Xiang Zhang
6721c7c3b2 Issue #29078: Add the missing import in datetime.time doc example.
Patch by Dhushyanth Ramasamy.
2016-12-27 12:23:59 +08:00
Serhiy Storchaka
4398c12b47 Issue #29068: Fixed a typo in PyErr_Fetch example.
Patch by Chi Hsuan Yen.
2016-12-25 16:22:23 +02:00
Martin Panter
7106a51c71 Issue #28954: Add missing comma to keyword argument syntax 2016-12-24 10:20:38 +00:00
Martin Panter
3dbd87f2b9 Issue #1446619: Account for negative slice direction in description
Based on suggestion from Fumihiro Bessho.
2016-12-24 08:25:15 +00:00
Martin Panter
3310e146cc Issue #29004: Document binascii.crc_hqx() implements CRC-CCITT 2016-12-24 07:36:44 +00:00
Martin Panter
972e04ec46 Issue #28960: Drop comma attached to dash in Thread.join() description 2016-12-24 07:28:26 +00:00
Ned Deily
e31b15c4ce Update documentation index sidebar for 3.6.0 release. 2016-12-23 04:13:31 -05:00
Brett Cannon
7e93c84438 Grammatical fixes following #d95f19892fd0 2016-12-22 10:02:01 -08:00