summaryrefslogtreecommitdiff
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
...
* bpo-36908: 'This module is always available' isn't helpful. (GH-13297)Miss Islington (bot)2019-05-172-9/+8
| | | | | | | Makes the documentation of math and cmath module more helpful for the beginners. (cherry picked from commit 6faad355db6c2bd4a0ade7868f245b42c04f5337) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* docs 36789: resolve incorrect note regarding UTF-8 (GH-13111)Miss Islington (bot)2019-05-171-5/+10
| | | | | (cherry picked from commit f98c3c59c0930ee41175d8935f72bfeed5fee17a) Co-authored-by: redshiftzero <jen@freedom.press>
* Doc: Add link threading.settrace to sys.settrace (GH-13345)Miss Islington (bot)2019-05-171-2/+2
| | | | | (cherry picked from commit 245f528a92d7748dbd7acf9cba860153c143bbfe) Co-authored-by: Stefan Hoelzl <stefan.hoelzl@posteo.de>
* Fix typos in documentation. Patch by tirkarthi. (GH-13354)Miss Islington (bot)2019-05-151-2/+2
| | | | | (cherry picked from commit 8a533ffb499b168ed4bdb707c9919290631e267d) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.7] bpo-36799: Fix typo in ctypes.rst (GH-13104) (GH-13341)Stéphane Wirtel2019-05-151-2/+2
| | | | | (cherry picked from commit 133fc89ca) Co-authored-by: Yavor Konstantinov <7553015+sehnsucht13@users.noreply.github.com>
* bpo-36760: Clarify subprocess capture_output docs. (GH-13322)Miss Islington (bot)2019-05-141-1/+3
| | | | | | Clarify how to capture stdout and stderr combined into one stream. (cherry picked from commit e883091abf7ca84a88e956fe5202e75c53bd4128) Co-authored-by: Gregory P. Smith <greg@krypto.org>
* bpo-32995 - Added context variable in glossary (GH-9741)Miss Islington (bot)2019-05-141-0/+9
| | | | | (cherry picked from commit c0a1a07c7e9814cad79cce3580c16284b2df7f52) Co-authored-by: Vinodhini Balusamy <me.vinob@gmail.com>
* Changes to the documentation of normcase (GH-4725)Miss Islington (bot)2019-05-131-4/+4
| | | | | (cherry picked from commit 32d1458b2e2e00eeb29022179eeb04b83fb7f3c4) Co-authored-by: Kexuan Sun <me@kianasun.com>
* bpo-35138: Added an example for timeit.timeit with callable arguments (GH-9787)Miss Islington (bot)2019-05-131-1/+5
| | | | | | * Update timeit.rst (cherry picked from commit 8da5ebe11e0cb6599af682b22f7c2b2b7b9debd8) Co-authored-by: Anders Hovmöller <boxed@killingar.net>
* Docs: Add bz2 usage examples (GH-13258)Miss Islington (bot)2019-05-131-5/+79
| | | | | | | | | | | | | * 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 be6939fb02e65b56c45377940b339d150b124d05) Co-authored-by: Brad <brad.solomon.1124@gmail.com>
* [3.7] bpo-36895: document time.clock() has been removed in 3.8 (GH-13287)Matthias Bussonnier2019-05-131-1/+1
|
* [3.7] bpo-34682: Wording and grammatical changes to the ↵Stéphane Wirtel2019-05-133-13/+13
| | | | | | | | doc(https://docs.python.org/3) (GH-13120) (GH-13281) https://bugs.python.org/issue34682 (cherry picked from commit 778a9107586e29421af3a08209cf0b557c1fe5bc) Co-authored-by: divyag9 <divyam9@gmail.com>
* bpo-33882: mention breakpoint() in debugger-related FAQ (GH-7759) (GH-13077)Miss Islington (bot)2019-05-131-0/+3
| | | | | (cherry picked from commit cf48e55f7f7718482fa712552f0cbc0aea1c826f) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* [3.7] bpo-36822: Fix minor grammatical error in glossary.rst (GH-13145). ↵Sanyam Khurana2019-05-121-4/+4
| | | | | | | (GH-13260) (cherry picked from commit 90fb04c1e23c0fddd438bd0f73e7c018cacef4bc) Co-authored-by: Sanyam Khurana <8039608+CuriousLearner@users.noreply.github.com>
* bpo-33071: remove outdated PyPI docs (GH-13087)Miss Islington (bot)2019-05-102-243/+6
| | | | | | Patch by Kojo Idrissa. (cherry picked from commit 1b4abcf302ff2c8f4d4881294510d48ba5186b53) Co-authored-by: Kojo Idrissa <kojoidrissa@users.noreply.github.com>
* [3.7] bpo-10536: Enhancements to gettext docs (GH-10324) (GH-13224)Miss Islington (bot)2019-05-091-23/+23
| | | | | | | | | (cherry picked from commit 55f3317e984cc35bd18ba0326ed98766a2750ffd) Co-authored-by: Stéphane Wirtel <stephane@wirtel.be> https://bugs.python.org/issue10536
* bpo-31873: Update unicode.rst - 'unicode' capitalization (GH-4125)Miss Islington (bot)2019-05-081-12/+12
| | | | | | | Update 'unicode' capitalization. 'Unicode' is a proper noun, and as such should be capitalized. Changed multiple instances. (cherry picked from commit 85225b6a58a516c50c055d5114668ed2fcdcda8c) Co-authored-by: toonarmycaptain <toonarmycaptain@hotmail.com>
* Doc: Be explicit that Pathlib resolve was strict before 3.6. (GH-11316)Miss Islington (bot)2019-05-081-1/+1
| | | | | (cherry picked from commit 1d4b16051f8550fd7dada3670a3e83ae13b99d3b) Co-authored-by: Julien Palard <julien@palard.fr>
* [3.7] Doc: Fix missing bracket (GH-13163) (GH-13189)Miss Islington (bot)2019-05-081-1/+1
| | | | | | (cherry picked from commit 70b80541bb044e8cb7037acaf97f64890fef418e) Co-authored-by: Zhaorong Ma <mazhaorong@gmail.com>
* Add a footnote about Cheese Shop in Doc/tutorial (GH-13103) (GH-13174)Miss Islington (bot)2019-05-071-1/+7
| | | | | (cherry picked from commit e19a91e45fd54a56e39c2d12e6aaf4757030507f) Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
* [3.7] bpo-11001: updated cookie docs (GH-13086) (GH-13161)Miss Islington (bot)2019-05-071-7/+9
| | | | | | | | | | | | | | Used **spookylukey**'s patch from 2011-01-24 https://bugs.python.org/issue11001 (cherry picked from commit 91cc01f40eec03ece2d6b04ad9ea786e77707d8d) Co-authored-by: Julia Iliuk <julia.iluyk@gmail.com> https://bugs.python.org/issue11001
* bpo-28795: Signal documentation: Fix misleading statement. (GH-13121)Miss Islington (bot)2019-05-071-1/+2
| | | | | (cherry picked from commit e85ef7a7eacdef2f43e6bf2e67f335100e7ef2da) Co-authored-by: Julien Palard <julien@palard.fr>
* bpo-36783: Added C API Documentation for Time_FromTimeAndFold and ↵Miss Islington (bot)2019-05-071-0/+16
| | | | | | | PyDateTime_FromDateAndTimeAndFold (GH-13147) (cherry picked from commit 5765ecf79fcee987f2f97c246c64b494324dfd33) Co-authored-by: Edison A <20975616+SimiCode@users.noreply.github.com>
* [3.7] bpo-36766: Typos in docs and code comments (GH-13116). (GH-13136)penguindustin2019-05-062-2/+2
| | | | | | | | | | | (cherry picked from commit 964663089547ca110199e23867b46b07ff4be88c) Co-authored-by: penguindustin <penguindustin@gmail.com> https://bugs.python.org/issue36766
* [3.7] Clarify the download unit in the download section (GH-13122) (GH-13130)Miss Islington (bot)2019-05-061-2/+1
| | | | | | (cherry picked from commit e9b49d1b4eec21f2da838db3360f6458cf648c36) Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
* bpo-36275: enhance documentation for venv.create() (GH-13114)Miss Islington (bot)2019-05-061-1/+6
| | | | | (cherry picked from commit 3921b1cc34c2fc8b8b480c19a95ec306de710fdd) Co-authored-by: Sebastian Koslowski <sebastian.koslowski@gmail.com>
* bpo-30668: add missing word in license.rst (GH-13115)Miss Islington (bot)2019-05-061-1/+1
| | | | | (cherry picked from commit 4920c093da8a3061faea62d62f2ddf0c5c443360) Co-authored-by: Patrick Mühlbauer <tmuxbiene@googlemail.com>
* bpo-36189: Fixing typo in tutorial introduction (GH-13093)Miss Islington (bot)2019-05-041-1/+1
| | | | | (cherry picked from commit 98a1e06c47f655c7601b130cf8d549de9f08369e) Co-authored-by: Jonatan <jonyucra@gmail.com>
* bpo-36166: Change to rst datamodel file. (GH-13089) (#13094)Miss Islington (bot)2019-05-041-2/+2
| | | | | (cherry picked from commit 5e98f05e55d13981c7c92fb14b9c013e4227c3c1) Co-authored-by: Catherine Alvarado <catherine@qventus.com>
* closes bpo-35329: Change 'Package' to 'package' in accordance with PEP8. ↵Miss Islington (bot)2019-04-291-1/+1
| | | | | | | (GH-13008) (cherry picked from commit ee0309f3d83ab9ffa02542bcf45ece84f4fb265e) Co-authored-by: Utkarsh Gupta <guptautkarsh2102@gmail.com>
* Syntax highlight IDLE html doc code example. (GH-12981)Miss Islington (bot)2019-04-261-4/+2
| | | | | | The new markup is currently ignored by IDLE's tk doc display. (cherry picked from commit 55d035113dfb1bd90495c8571758f504ae8d4802) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-30840: Document relative imports (GH-12831) (GH-12938)Miss Islington (bot)2019-04-252-1/+42
| | | | | | * Document relative imports (cherry picked from commit 70bf713617e15fad390ed953e48b3c65d9bc90ec) Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
* replace 'sequencial argument' by 'positional' in doc (GH-12925)Miss Islington (bot)2019-04-231-1/+1
| | | | | (cherry picked from commit 29d018aa63b72161cfc67602dc3dbd386272da64) Co-authored-by: Mathieu Dupuy <deronnax@users.noreply.github.com>
* Doc: add the missing ".tp_flags" in type definition (GH-12902)Miss Islington (bot)2019-04-221-0/+1
| | | | | (cherry picked from commit 662ebd2ab2047aeae9689ad254b39915c38069fd) Co-authored-by: Wu Wei <weiwu@cacheme.net>
* bpo-36645: Fix ambiguous formatting in re.sub() documentation (GH-12879)Miss Islington (bot)2019-04-211-0/+1
| | | | | (cherry picked from commit 5ebfa840a1c9967da299356733da41b532688988) Co-authored-by: mollison <mollison@cs.unc.edu>
* Fix typo (GH-12878)Miss Islington (bot)2019-04-201-1/+1
| | | | | | "sychronization" -> "synchronization" (cherry picked from commit 3e986de0d65e78901b55d4e500b1d05c847b6d5e) Co-authored-by: Fredrik Averpil <fredrik@averpil.com>
* bpo-36651: Fixed Asyncio Event Loop documentation inconsistency (GH-12866)Miss Islington (bot)2019-04-181-3/+3
| | | | | | | | | | | | | 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 7e954e7de4f3777b5ce239640bd2b76aced09561) Co-authored-by: Enrico Alarico Carbognani <enrico.carbognani@gmail.com>
* Fix wrong indentation of a paragraph in documentation (GH-12868)Miss Islington (bot)2019-04-171-2/+2
| | | | | | This paragraph doesn't seem to be a part of code, but merged into previous code block. (cherry picked from commit 9941f963fe085261aec25545fa9f0cc35f750120) Co-authored-by: cocoatomo <cocoatomo77@gmail.com>
* bpo-33783: Use proper class markup for random.Random docs (GH-7817) (GH-12859)Miss Islington (bot)2019-04-161-0/+5
| | | | | | Signed-off-by: Matthias Bussonnier <bussonniermatthias@gmail.com> (cherry picked from commit 31e8d69bfe7cf5d4ffe0967cb225d2a8a229cc97) Co-authored-by: Matthias Bussonnier <bussonniermatthias@gmail.com>
* Doc: update PendingDeprecationWarning explanation (GH-12837)Miss Islington (bot)2019-04-151-9/+6
| | | | | | | | | 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 a3283efd30ad52b56d1046138523cbabc6c69daf) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* [3.7] bpo-36427: Document that PyEval_RestoreThread and PyGILState_Ensure ↵Pablo Galindo2019-04-141-0/+12
| | | | | | | | | 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)
* Doc: define PY_SSIZE_T_CLEAN always (GH-12794)Miss Islington (bot)2019-04-1210-4/+22
| | | | | (cherry picked from commit c88feceb449d6e85d7e17ec36559206094d10d81) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* bpo-35581: Document @typing.type_check_only (GH-11312)Miss Islington (bot)2019-04-121-0/+18
| | | | | (cherry picked from commit 1e8295402bf5e81d327ed2b5eb88a6b6de449d63) Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
* bpo-33922: Adding documentation for new "-64" suffix of Python launcher ↵Miss Islington (bot)2019-04-121-13/+23
| | | | | | | | (GH-7849) Since bpo-30291 it is possible to specify the architecture of Python when using the launcher (cherry picked from commit 1e2ad6c275d2b09e76b7cbba7281d5a125a593c1) Co-authored-by: mrh1997 <mrh1997@users.noreply.github.com>
* bpo-34839: Add a 'before 3.6' in the section 'warnings' of doctest (GH-9736)Miss Islington (bot)2019-04-111-7/+11
| | | | | (cherry picked from commit 0522fd81dc6e3482c2d4c8719f1f85ad5924eede) Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
* [3.7] bpo-36389: _PyObject_IsFreed() now also detects uninitialized memory ↵Victor Stinner2019-04-111-2/+9
| | | | | | | | | | | | | | | | | | | | | | | | (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 2b00db68554422ec37faba2a80179a0172df6349) * 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 4c409beb4c360a73d054f37807d3daad58d1b567)
* bpo-36597: fix random doctest failure (GH-12778)Inada Naoki2019-04-111-5/+8
|
* bpo-36416: Correct bytes.rpartition documentation (GH-12543)Miss Islington (bot)2019-04-111-2/+2
| | | | | (cherry picked from commit efc48701496ef020e896fc6a91af3c0c612ac69a) Co-authored-by: pewscorner <pewscorner@users.noreply.github.com>
* Doc: fix typo in IncrementalDecoder.setstate (GH-12724)Miss Islington (bot)2019-04-101-1/+1
| | | | | (cherry picked from commit b5e2959b27088d39f9954a207b91ab0ebbd149f4) Co-authored-by: Christopher Thorne <libcthorne@users.noreply.github.com>
* better __init__.py explanation in tutorial (GH-12763)Miss Islington (bot)2019-04-101-3/+3
| | | | | | | | | | * better __init__.py explanation in tutorial * Update Doc/tutorial/modules.rst Co-Authored-By: methane <songofacandy@gmail.com> (cherry picked from commit 5410d3d283b11e2375f0c1f79728a230edd12bd0) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
View Lorry Controller Status