Commit graph

21787 commits

Author SHA1 Message Date
Stéphane Wirtel
4fd7f56ee7
[3.7] bpo-36799: Fix typo in ctypes.rst (GH-13104) (GH-13341)
(cherry picked from commit 133fc89ca)

Co-authored-by: Yavor Konstantinov <7553015+sehnsucht13@users.noreply.github.com>
2019-05-15 17:53:25 +02:00
Miss Islington (bot)
822683238c
bpo-36760: Clarify subprocess capture_output docs. (GH-13322)
Clarify how to capture stdout and stderr combined into one stream.
(cherry picked from commit e883091abf)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2019-05-14 12:39:17 -07:00
Miss Islington (bot)
8b3823ae16
bpo-32995 - Added context variable in glossary (GH-9741)
(cherry picked from commit c0a1a07c7e)

Co-authored-by: Vinodhini Balusamy <me.vinob@gmail.com>
2019-05-14 05:24:42 -07:00
Miss Islington (bot)
da86bf7396
Changes to the documentation of normcase (GH-4725)
(cherry picked from commit 32d1458b2e)

Co-authored-by: Kexuan Sun <me@kianasun.com>
2019-05-13 19:21:25 -07:00
Miss Islington (bot)
7f485ea4fc
bpo-35138: Added an example for timeit.timeit with callable arguments (GH-9787)
* Update timeit.rst
(cherry picked from commit 8da5ebe11e)

Co-authored-by: Anders Hovmöller <boxed@killingar.net>
2019-05-13 12:41:31 -07:00
Miss Islington (bot)
ee9b5ce390
Docs: Add bz2 usage examples (GH-13258)
* Docs: Add bz2 usage examples

- Adds an "Examples of usage" section inspired by the one
  found in the gzip docs
- Corrects the descriptions for ``compresslevel`` and ``data``:
    - ``compresslevel`` must be an `int`, not any number.  For
      instance, passing a float will raise ``TypeError``
    - Notes that `data` must be bytes-like
(cherry picked from commit be6939fb02)

Co-authored-by: Brad <brad.solomon.1124@gmail.com>
2019-05-13 11:50:16 -07:00
Matthias Bussonnier
24482bd0ae [3.7] bpo-36895: document time.clock() has been removed in 3.8 (GH-13287) 2019-05-13 18:08:48 +02:00
Stéphane Wirtel
074d7c44a4 [3.7] bpo-34682: Wording and grammatical changes to the doc(https://docs.python.org/3) (GH-13120) (GH-13281)
https://bugs.python.org/issue34682
(cherry picked from commit 778a910758)

Co-authored-by: divyag9 <divyam9@gmail.com>
2019-05-13 15:48:49 +02:00
Miss Islington (bot)
af5ef3e107 bpo-33882: mention breakpoint() in debugger-related FAQ (GH-7759) (GH-13077)
(cherry picked from commit cf48e55f7f)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-05-13 15:03:10 +02:00
Sanyam Khurana
4f5febdf95 [3.7] bpo-36822: Fix minor grammatical error in glossary.rst (GH-13145). (GH-13260)
(cherry picked from commit 90fb04c1e2)

Co-authored-by: Sanyam Khurana <8039608+CuriousLearner@users.noreply.github.com>
2019-05-12 04:53:02 +01:00
Miss Islington (bot)
069a5b4833
bpo-33071: remove outdated PyPI docs (GH-13087)
Patch by Kojo Idrissa.
(cherry picked from commit 1b4abcf302)

Co-authored-by: Kojo Idrissa <kojoidrissa@users.noreply.github.com>
2019-05-10 01:50:54 -07:00
Miss Islington (bot)
98b360e27b
[3.7] bpo-10536: Enhancements to gettext docs (GH-10324) (GH-13224)
(cherry picked from commit 55f3317e98)


Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>


https://bugs.python.org/issue10536
2019-05-09 13:26:09 -07:00
Miss Islington (bot)
ed8860c5af
bpo-31873: Update unicode.rst - 'unicode' capitalization (GH-4125)
Update 'unicode' capitalization. 'Unicode' is a proper noun, and as such should be capitalized.
Changed multiple instances.
(cherry picked from commit 85225b6a58)

Co-authored-by: toonarmycaptain <toonarmycaptain@hotmail.com>
2019-05-08 09:34:12 -07:00
Miss Islington (bot)
5e08fe18a7
Doc: Be explicit that Pathlib resolve was strict before 3.6. (GH-11316)
(cherry picked from commit 1d4b16051f)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-05-08 08:26:23 -07:00
Miss Islington (bot)
3afbe69988
[3.7] Doc: Fix missing bracket (GH-13163) (GH-13189)
(cherry picked from commit 70b80541bb)


Co-authored-by: Zhaorong Ma <mazhaorong@gmail.com>
2019-05-08 07:07:02 -07:00
Miss Islington (bot)
5edd82c806 Add a footnote about Cheese Shop in Doc/tutorial (GH-13103) (GH-13174)
(cherry picked from commit e19a91e45f)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2019-05-07 21:59:20 +01:00
Miss Islington (bot)
1fe722cf14
[3.7] bpo-11001: updated cookie docs (GH-13086) (GH-13161)
Used **spookylukey**'s patch from 2011-01-24



https://bugs.python.org/issue11001
(cherry picked from commit 91cc01f40e)


Co-authored-by: Julia Iliuk <julia.iluyk@gmail.com>


https://bugs.python.org/issue11001
2019-05-07 10:32:45 -07:00
Miss Islington (bot)
721729fca4
bpo-28795: Signal documentation: Fix misleading statement. (GH-13121)
(cherry picked from commit e85ef7a7ea)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-05-07 08:55:39 -07:00
Miss Islington (bot)
146010ea42
bpo-36783: Added C API Documentation for Time_FromTimeAndFold and PyDateTime_FromDateAndTimeAndFold (GH-13147)
(cherry picked from commit 5765ecf79f)

Co-authored-by: Edison A <20975616+SimiCode@users.noreply.github.com>
2019-05-07 08:17:50 -07:00
penguindustin
b2d29bfa5b [3.7] bpo-36766: Typos in docs and code comments (GH-13116). (GH-13136)
(cherry picked from commit 9646630895)

Co-authored-by: penguindustin <penguindustin@gmail.com>





https://bugs.python.org/issue36766
2019-05-06 13:55:19 -07:00
Miss Islington (bot)
88a2074e3b
[3.7] Clarify the download unit in the download section (GH-13122) (GH-13130)
(cherry picked from commit e9b49d1b4e)


Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2019-05-06 12:32:52 -07:00
Miss Islington (bot)
9a03c77328
bpo-36275: enhance documentation for venv.create() (GH-13114)
(cherry picked from commit 3921b1cc34)

Co-authored-by: Sebastian Koslowski <sebastian.koslowski@gmail.com>
2019-05-06 12:25:59 -07:00
Miss Islington (bot)
8777915ade
bpo-30668: add missing word in license.rst (GH-13115)
(cherry picked from commit 4920c093da)

Co-authored-by: Patrick Mühlbauer <tmuxbiene@googlemail.com>
2019-05-06 12:08:10 -07:00
Miss Islington (bot)
2b5ffc02c0 bpo-36189: Fixing typo in tutorial introduction (GH-13093)
(cherry picked from commit 98a1e06c47)

Co-authored-by: Jonatan <jonyucra@gmail.com>
2019-05-04 23:22:34 -04:00
Miss Islington (bot)
37125ff6e2 bpo-36166: Change to rst datamodel file. (GH-13089) (#13094)
(cherry picked from commit 5e98f05e55)

Co-authored-by: Catherine Alvarado <catherine@qventus.com>
2019-05-04 23:21:28 -04:00
Miss Islington (bot)
4b5340bb63
closes bpo-35329: Change 'Package' to 'package' in accordance with PEP8. (GH-13008)
(cherry picked from commit ee0309f3d8)

Co-authored-by: Utkarsh Gupta <guptautkarsh2102@gmail.com>
2019-04-29 19:26:00 -07:00
Miss Islington (bot)
5d90954856
Syntax highlight IDLE html doc code example. (GH-12981)
The new markup is currently ignored by IDLE's tk doc display.
(cherry picked from commit 55d035113d)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2019-04-26 20:42:05 -07:00
Miss Islington (bot)
4d0233ec65 bpo-30840: Document relative imports (GH-12831) (GH-12938)
* Document relative imports
(cherry picked from commit 70bf713617)

Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
2019-04-25 01:44:19 +10:00
Miss Islington (bot)
e64d21b187
replace 'sequencial argument' by 'positional' in doc (GH-12925)
(cherry picked from commit 29d018aa63)

Co-authored-by: Mathieu Dupuy <deronnax@users.noreply.github.com>
2019-04-23 06:06:57 -07:00
Miss Islington (bot)
8c49d71385
Doc: add the missing ".tp_flags" in type definition (GH-12902)
(cherry picked from commit 662ebd2ab2)

Co-authored-by: Wu Wei <weiwu@cacheme.net>
2019-04-22 04:14:25 -07:00
Miss Islington (bot)
71b88827f6
bpo-36645: Fix ambiguous formatting in re.sub() documentation (GH-12879)
(cherry picked from commit 5ebfa840a1)

Co-authored-by: mollison <mollison@cs.unc.edu>
2019-04-21 15:20:45 -07:00
Miss Islington (bot)
307e7a4264
Fix typo (GH-12878)
"sychronization" -> "synchronization"
(cherry picked from commit 3e986de0d6)

Co-authored-by: Fredrik Averpil <fredrik@averpil.com>
2019-04-20 16:12:23 -07:00
Miss Islington (bot)
d29b3dd922
bpo-36651: Fixed Asyncio Event Loop documentation inconsistency (GH-12866)
GH- [bpo-36651](https://bugs.python.org/issue36651): Fixed Asyncio Event Loop documentation inconsistency

In the documentation for the call_later and the call_at methods there is a note which says that the delay cannot be longer than a day, but both methods have a note saying that this limitation was removed in Python 3.8
Here I fixed this issue by removing the pre-exising note and added a versionchanged.

To test my changes I have rebuilt the documentation with ```make html```. I did not have any errors and the effected page displayed correctly on a browser.

https://bugs.python.org/issue36651
(cherry picked from commit 7e954e7de4)

Co-authored-by: Enrico Alarico Carbognani <enrico.carbognani@gmail.com>
2019-04-18 05:49:24 -07:00
Miss Islington (bot)
21c8caa16a
Fix wrong indentation of a paragraph in documentation (GH-12868)
This paragraph doesn't seem to be a part of code, but merged into previous code block.
(cherry picked from commit 9941f963fe)

Co-authored-by: cocoatomo <cocoatomo77@gmail.com>
2019-04-17 18:00:37 -07:00
Miss Islington (bot)
a6fce19968 bpo-33783: Use proper class markup for random.Random docs (GH-7817) (GH-12859)
Signed-off-by: Matthias Bussonnier <bussonniermatthias@gmail.com>
(cherry picked from commit 31e8d69bfe)

Co-authored-by: Matthias Bussonnier <bussonniermatthias@gmail.com>
2019-04-16 23:32:32 +02:00
Miss Islington (bot)
871ba6c848
Doc: update PendingDeprecationWarning explanation (GH-12837)
Keep the nudge towards DeprecationWarning, but remove the
"Note" markup and generally shorten the description.

Ref: https://github.com/python/cpython/pull/12505/filesGH-r273978757
(cherry picked from commit a3283efd30)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2019-04-15 05:48:31 -07:00
Pablo Galindo
7723d0545c
[3.7] bpo-36427: Document that PyEval_RestoreThread and PyGILState_Ensure can terminate the calling thread (GH-12541) (GH-12820)
Calling these function from a thread when the runtime is finalizing will terminate
the thread, even if the thread was not created by Python. Users can use
_Py_IsFinalizing or sys.is_finalizing to check if the interpreter is in the process of
being finalized before calling this function to avoid unwanted termination.
(cherry picked from commit fde9b33)
2019-04-14 03:49:17 +01:00
Miss Islington (bot)
be63df287a
Doc: define PY_SSIZE_T_CLEAN always (GH-12794)
(cherry picked from commit c88feceb44)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2019-04-12 18:56:50 -07:00
Miss Islington (bot)
b759a2c5b9
bpo-35581: Document @typing.type_check_only (GH-11312)
(cherry picked from commit 1e8295402b)

Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
2019-04-12 15:47:57 -07:00
Miss Islington (bot)
395bb94a7f
bpo-33922: Adding documentation for new "-64" suffix of Python launcher (GH-7849)
Since bpo-30291 it is possible to specify the architecture of Python when using the launcher
(cherry picked from commit 1e2ad6c275)

Co-authored-by: mrh1997 <mrh1997@users.noreply.github.com>
2019-04-12 15:32:33 -07:00
Miss Islington (bot)
a910c2c6f3
bpo-34839: Add a 'before 3.6' in the section 'warnings' of doctest (GH-9736)
(cherry picked from commit 0522fd81dc)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2019-04-11 23:27:27 -07:00
Victor Stinner
9e23f0a27c
[3.7] bpo-36389: _PyObject_IsFreed() now also detects uninitialized memory (GH-12770) (GH-12788)
* bpo-36389: _PyObject_IsFreed() now also detects uninitialized memory (GH-12770)

Replace _PyMem_IsFreed() function with _PyMem_IsPtrFreed() inline
function. The function is now way more efficient, it became a simple
comparison on integers, rather than a short loop. It detects also
uninitialized bytes and "forbidden bytes" filled by debug hooks
on memory allocators.

Add unit tests on _PyObject_IsFreed().

(cherry picked from commit 2b00db6855)

* bpo-36389: Change PyMem_SetupDebugHooks() constants (GH-12782)

Modify CLEANBYTE, DEADDYTE and FORBIDDENBYTE constants: use 0xCD,
0xDD and 0xFD, rather than 0xCB, 0xBB and 0xFB, to use the same byte
patterns than Windows CRT debug malloc() and free().

(cherry picked from commit 4c409beb4c)
2019-04-11 22:30:31 +02:00
Inada Naoki
ac31da8f37
bpo-36597: fix random doctest failure (GH-12778) 2019-04-11 19:37:53 +09:00
Miss Islington (bot)
04b114eede
bpo-36416: Correct bytes.rpartition documentation (GH-12543)
(cherry picked from commit efc4870149)

Co-authored-by: pewscorner <pewscorner@users.noreply.github.com>
2019-04-11 03:18:48 -07:00
Miss Islington (bot)
a8c4fa5319
Doc: fix typo in IncrementalDecoder.setstate (GH-12724)
(cherry picked from commit b5e2959b27)

Co-authored-by: Christopher Thorne <libcthorne@users.noreply.github.com>
2019-04-10 23:18:07 -07:00
Miss Islington (bot)
59fd08c25c
better __init__.py explanation in tutorial (GH-12763)
* better __init__.py explanation in tutorial

* Update Doc/tutorial/modules.rst

Co-Authored-By: methane <songofacandy@gmail.com>
(cherry picked from commit 5410d3d283)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2019-04-10 23:16:34 -07:00
Miss Islington (bot)
9d2ccf173e
bpo-14826: document that URLopener quotes fullurl. (GH-12758)
(cherry picked from commit 2fb2bc81c3)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2019-04-10 02:30:22 -07:00
Miss Islington (bot)
0a16bb15af
closes bpo-35848: Move all documentation regarding the readinto out of IOBase. (GH-11893)
Move all documentation regarding the readinto method into either io.RawIOBase or io.BufferedIOBase.

Corresponding changes to documentation in the _pyio.py module.
(cherry picked from commit 7b97ab35b2)

Co-authored-by: Steve Palmer <steve@srpalmer.me.uk>
2019-04-08 21:57:31 -07:00
Miss Islington (bot)
1f0ff57acb
Correct "inplace" with "in-place" (GH-10480)
(cherry picked from commit f4efa312d1)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-04-08 02:21:38 -07:00
Miss Islington (bot)
a9a065addd
bpo-9883: Update list of unimplemented interfaces in minidom. (GH-12677)
Remove names from the "unimplemented interfaces" list
in the minidom docs that are actually implemented.
(cherry picked from commit 2ea8099523)

Co-authored-by: Stefan Behnel <stefan_ml@behnel.de>
2019-04-07 19:55:58 -07:00