Commit Graph

21881 Commits

Author SHA1 Message Date
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
Miss Islington (bot) 1bc6cd7066
Fix doc for create_subprocess_exec (GH-12598)
Add missing `program` argument to asyncio.create_subprocess_exec documentation.
(cherry picked from commit 1328375ad1)

Co-authored-by: Dima Tisnek <dimaqq@gmail.com>
2019-04-05 07:08:31 -07:00
Miss Islington (bot) 86fbe0287d
bpo-36404: recommend DeprecationWarning over PendingDeprecationWarning (GH-12505)
(cherry picked from commit 176d26364b)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2019-04-05 02:07:21 -07:00
Miss Islington (bot) ef516d11c1
bpo-32413: Add documentation that at the module level, locals(), globals() are the same dictionary (GH-5004)
https://bugs.python.org/issue32413
(cherry picked from commit 1c5fa5af8a)

Co-authored-by: Srinivas Reddy Thatiparthy (శ్రీనివాస్  రెడ్డి తాటిపర్తి) <thatiparthysreenivas@gmail.com>
2019-04-02 11:14:50 -07:00
Miss Islington (bot) 9a838c593f
bpo-35838: document optionxform must be idempotent (GH-12656)
(cherry picked from commit 04694a306b)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2019-04-02 02:29:16 -07:00
Miss Islington (bot) 35fc38e5e8
bpo-36157:Document PyInterpreterState_Main() (GH-12238)
I have added documentation for `PyInterpreterState_Main()`.
 I chose to place it under Advanced Debugger Support together with similar functions like `PyInterpreterState_Head()`, `PyInterpreterState_Next(`), and `PyInterpreterState_ThreadHead()` .

https://bugs.python.org/issue36157
(cherry picked from commit 8c61739def)

Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
2019-04-01 08:15:10 -07:00
Inada Naoki 8384670615
bpo-20844: open script file with "rb" mode (GH-12616)
(cherry picked from commit 10654c19b5)
2019-04-01 21:02:51 +09:00
Miss Islington (bot) 128e40f06f
C API docs: Py_IsInitialized is always safe to call (GH-12630)
(cherry picked from commit ddbb978e10)

Co-authored-by: Nick Coghlan <ncoghlan@gmail.com>
2019-03-30 04:29:43 -07:00
Miss Islington (bot) 5b80cb5584
bpo-17110: doc: add note how to get bytes from sys.argv (GH-12602)
(cherry picked from commit 38f4e468d4)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2019-03-29 22:38:14 -07:00
Miss Islington (bot) 40ee9a3640
Fixed capital letters missing and missing . (GH-12584)
No `bpo` for minor doc fix
(cherry picked from commit 3d78c4a6e5)

Co-authored-by: Jules Lasne (jlasne) <jlasne@student.42.fr>
2019-03-28 19:11:06 -07:00
Miss Islington (bot) 1d9f1a0c96
bpo-36425: Add Simplified Chinese to the language switcher (GH-12537)
(cherry picked from commit 45a5fdb91c)

Co-authored-by: zhsj <zsj950618@gmail.com>
2019-03-28 11:12:39 -07:00
Miss Islington (bot) 101ddba62d
Doc: Fixed missing punctuation in datamodel.rst (GH-12581)
(cherry picked from commit 1fc5bf2ff2)

Co-authored-by: Jules Lasne (jlasne) <jlasne@student.42.fr>
2019-03-27 03:18:36 -07:00
Miss Islington (bot) ead1579598
bpo-33832: Add "magic method" glossary entry (GH-7630)
(cherry picked from commit f760610bdd)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-03-26 18:26:52 -07:00
Miss Islington (bot) e16599c48c
Minor doc improvement (GH-10341)
Change "star-operator" to "* operator".
(cherry picked from commit dfd775a0b1)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-03-26 18:23:54 -07:00
Miss Islington (bot) 5ac626350e
bpo-34203: FAQ: improve wording of paragraph about 2.x vs. 3.x (GH-9821)
(cherry picked from commit 6cd658b1a5)

Co-authored-by: Tal Einat <taleinat+github@gmail.com>
2019-03-26 14:20:29 -07:00
Miss Islington (bot) eb94e5b3ec
Fix "the the" in the idle docs. (GH-12549)
(cherry picked from commit 577277f669)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2019-03-25 21:52:39 -07:00
Miss Islington (bot) b23b08623a
bpo-34085: Improve wording on classmethod/staticmethod (GH-8228)
* bpo-34085: Improve wording on classmethod/staticmethod

* Address comments from Éric

* Address comments from Éric
(cherry picked from commit 548cb6060a)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-03-25 16:00:00 -07:00
Miss Islington (bot) f3c5535f63 Add note to Queue.get() docs about block=True (GH-2223) (GH-12538)
(cherry picked from commit 713a8ae792)

Co-authored-by: Stephen Rosen <sirosen@globus.org>
2019-03-25 13:03:16 -07:00
Miss Islington (bot) fc00102363
bpo-31822: Document that urllib.parse.{Defrag,Split,Parse}Result are namedtuples (GH-4434)
(cherry picked from commit 13c1f72cd1)

Co-authored-by: Lisa Roach <lisaroach14@gmail.com>
2019-03-24 14:56:27 -07:00
Miss Islington (bot) 4d5f1a4bb9
[3.7] Replace "DOS box" with link to Windows FAQ. (GH-12390) (GH-12525)
(cherry picked from commit 6661c1720e)


Co-authored-by: Ned Deily <nad@python.org>
2019-03-24 12:12:05 -07:00
Miss Islington (bot) 9cdac5ced6
bpo-33319: Clarify subprocess call docs. (GH-12508)
Clarify capturing or suppressing stdout and stderr on the old call APIs.

Do not state that they are equivalent to run() calls when they are not implemented using run as that was misleading. Unlike run they cannot handle stdout or stderr being set to PIPE without a risk of deadlock.
(cherry picked from commit 7a2e84c348)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2019-03-23 00:46:15 -07:00
Miss Islington (bot) 868581ee76
bpo-35155: clarify protocol handler method naming (GH-10313)
Clarify that the naming of protocol handler methods shouldn't be literally called "protocol" but should be named after the actual protocol.

https://bugs.python.org/issue35155
(cherry picked from commit dd7c4ceed9)

Co-authored-by: Denton Liu <liu.denton+github@gmail.com>
2019-03-22 16:30:04 -07:00
Miss Islington (bot) cb2d71b28e bpo-23984: Improve descriptor documentation (GH-1034) (GH-12459) 2019-03-22 01:04:21 -07:00
Julien Palard 756cfd8892
[3.7] bpo-35564: add master_doc='contents' to conf.py (GH-12460)
(cherry picked from commit fc8284e220)

Co-authored-by: Jean-François B <jfbu@free.fr>
2019-03-20 10:40:30 +01:00
Miss Islington (bot) bedfbc790e bpo-36321: Fix misspelled attribute in namedtuple() (GH-12375) (GH-12395)
(cherry picked from commit 23581c018f)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-03-18 00:48:02 -07:00
Mariatta 76ff715e03
Fix typo in unittest.mock documentation: manger -> manager (GH-12352)
(cherry picked from commit dc69f69f14)

Co-authored-by: Joan Massich <mailsik@gmail.com>
2019-03-17 16:53:06 -07:00
Miss Islington (bot) 68e0ed6a90
Update the seealso entries for namedtuple() (GH-12373)
* Replace external recipe link with a link to the dataclasses module.

* Highlight the class definition syntax for typing.NamedTuple
  and add an example for clarity.
(cherry picked from commit 9c68543f02)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-03-16 13:01:35 -07:00
Miss Islington (bot) e213cd6325
bpo-36138: Clarify docs about converting datetime.timedelta to scalars. (GH-12137)
Be explicit that timedelta division converts an overall duration to the interval
units given by the denominator.
(cherry picked from commit f40b4a0b62)

Co-authored-by: Yasser A <yalshalaan@gmail.com>
2019-03-15 21:03:43 -07:00
Miss Islington (bot) 2c177ec6c5
[3.7] Doc: Fix inconsistency in multiprocessing (GH-12273) (GH-12275)
(cherry picked from commit d9bd8ec2a4)


Co-authored-by: Julien Palard <julien@palard.fr>
2019-03-11 07:23:30 -07:00
Miss Islington (bot) 87f5255cdc
bpo-21314: Add a FAQ entry about positional only parameters (GH-10641)
(cherry picked from commit 1aeeaeb79e)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2019-03-10 04:36:18 -07:00
Miss Islington (bot) ae2378af3e
Fix padding on asyncio.IncompleteReadError docs (GH-12258)
(cherry picked from commit 11205b8030)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-03-10 04:12:12 -07:00
Steve Dower daad2c482c
bpo-36216: Add check for characters in netloc that normalize to separators (GH-12201) 2019-03-07 09:08:18 -08:00
Miss Islington (bot) bf44f48b63
Fix the documentation for set.copy() (GH-12176)
Remove 's' mention as there's no argument.
(cherry picked from commit e942e7b5c9)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-03-06 21:30:33 -08:00
Miss Islington (bot) ca5ba3c8ac
bpo-36185: Fix typo in Doc/c-api/objbuffer.rst. (GH-12204)
(cherry picked from commit ecc161d120)

Co-authored-by: Emmanuel Arias <emmanuelarias30@gmail.com>
2019-03-06 21:24:55 -08:00
Miss Islington (bot) bf35cc2593
Doc: Use `option` word for command line interface. (GH-12142)
For command line option, `option` is better than `parameter`.
(cherry picked from commit 0983fcd0d5)

Co-authored-by: NAKAMURA Osamu <osamu0329nakamura@users.noreply.github.com>
2019-03-04 20:49:47 -08:00
Miss Islington (bot) 3f1f9f0eee
Fixed a missing . and a missing capital letter. (GH-12170)
(cherry picked from commit 7e9ce4c89e)

Co-authored-by: Jules Lasne (jlasne) <jlasne@student.42.fr>
2019-03-04 11:41:31 -08:00
Miss Islington (bot) 84fa6b9e59
bpo-20906: Various revisions to the Unicode howto (GH-8394)
* bpo-20906: Corrections & revisions to Unicode HOWTO

* bpo-34484: don't describe range as a Private Use Area
(cherry picked from commit 97c288df61)

Co-authored-by: Andrew Kuchling <amk@amk.ca>
2019-03-04 05:01:47 -08:00
Cheryl Sabella 7dc322f8a5 [3.7] Add versionadded directives to ssl.minimum_version and ssl.maxi… (GH-12101)
…mum_version (GH-11894).

(cherry picked from commit ae2ea33d5d)

Co-authored-by: Zhiming Wang <i@zhimingwang.org>
2019-02-28 10:11:35 -08:00
Miss Islington (bot) 661151b341
Document the surprising sideeffect PyErr_Print(). (GH-12081)
Did you know an API documented as printing the pending traceback would sometimes exit the process?

You do now.
(cherry picked from commit 4173772031)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2019-02-27 15:45:28 -08:00
Miss Islington (bot) 79e72591b1
Fix grammar error in timeit module docs (GH-12066)
skip issue
skip news
(cherry picked from commit 4064089fce)

Co-authored-by: Shiv Dhar <shivdhar@gmail.com>
2019-02-27 15:27:36 -08:00
Miss Islington (bot) 197e46829b
[3.7] Update FAQ to point to Infrastructure Team website. (GH-12077) (GH-12078)
(cherry picked from commit ccb92e814d)


Co-authored-by: Ned Deily <nad@python.org>
2019-02-27 14:29:13 -08:00
Serhiy Storchaka 95fc8e687c
[3.7] bpo-28450: Fix and improve the documentation for unknown escapes in RE. (GH-11920). (GH-12029)
(cherry picked from commit a180b007d9)
2019-02-25 18:28:53 +02:00
Miss Islington (bot) a1caf65d5e
Remove empty Dictionaries section from programming FAQ (GH-12026)
(cherry picked from commit 55e335d7d5)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-02-25 08:27:54 -08:00
Miss Islington (bot) d14999b184
Correct name of 'defaultobj' parameter in PyDict_SetDefault() signature. (GH-11929)
(cherry picked from commit d90a141bb9)

Co-authored-by: Sergey Fedoseev <fedoseev.sergey@gmail.com>
2019-02-25 07:18:20 -08:00
Miss Islington (bot) 38aea4131f
bpo-24310: Document IDLE settings dialog font tab sample (GH-12007)
(cherry picked from commit d610116a2e)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2019-02-23 20:23:08 -08:00
Miss Islington (bot) 6163210089
bpo-36019: Use pythontest.net instead of example.com in network tests (GH-11941)
(cherry picked from commit a40681dd5d)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2019-02-22 06:03:26 -08:00
Miss Islington (bot) 1b2ff9ff09
Include the --prompt flag in venv's help output (GH-10711)
Document usage of the existing `--prompt` option in the command line help.
(cherry picked from commit 3208880f1c)

Co-authored-by: Holger Frey <socials@holgerfrey.de>
2019-02-22 03:14:08 -08:00
Julien Palard 22bfe637ca [3.7] Doc: Missing backquotes. (GH-11982) (GH-11985)
(cherry picked from commit 6e240ddd0d)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-02-22 00:56:06 -08:00
Miss Islington (bot) b046f1bada
bpo-28235: Fix xml.etree.ElementTree.fromstring docs (GH-11903)
(cherry picked from commit e5458bdb6a)

Co-authored-by: Manjusaka <lizheao940510@gmail.com>
2019-02-21 16:45:31 -08:00
Miss Islington (bot) 7121a6eeb7 bpo-36060: Document how collections.ChainMap() determines iteration order (GH-11969) (GH-11978)
(cherry picked from commit 86f093f71a)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-02-21 09:47:46 -08:00
Miss Islington (bot) 3bd3a71a1a Document other performance implication for __slots__ (GH-11974) (GH-11975)
(cherry picked from commit 7463884f69)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-02-21 09:10:20 -08:00
Miss Islington (bot) 300605990d bpo-36059: Update OrderedDict() docs to reflect that regular dicts are now ordered (GH-11966) (GH-#11972)
(cherry picked from commit 49fd6dd887)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-02-21 00:18:51 -08:00
Miss Islington (bot) 92ac01b104
Doc: fix example for iter() function. (GH-11959)
read() returns bytes for a file opened in binary mode,
so b'' should be used as a sentinel instead of ''.
Otherwise the loop will be infinite.
(cherry picked from commit 11fa0e48a9)

Co-authored-by: Cristian Ciupitu <cristian.ciupitu@yahoo.com>
2019-02-20 23:59:28 -08:00
Miss Islington (bot) 14baf06feb bpo-31982: Improve sequence of presentation in ChainMap docs (GH-11960) (GH-11961)
https://bugs.python.org/issue31982
(cherry picked from commit 9b0c681e2d)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-02-20 14:23:29 -08:00
Miss Islington (bot) bb9ddee3d4 bpo-35584: Clarify role of caret in a class class (GH-11946) (GH-11947)
https://bugs.python.org/issue35584
(cherry picked from commit 3bacf61265)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-02-19 12:25:54 -08:00
Miss Islington (bot) 0e379d43ac
bpo-34294: re module, fix wrong capturing groups in rare cases. (GH-11546)
Need to reset capturing groups between two SRE(match) callings in loops, this fixes wrong capturing groups in rare cases.

Also add a missing index in re.rst.
(cherry picked from commit 4a7f44a2ed)

Co-authored-by: animalize <animalize@users.noreply.github.com>
2019-02-18 05:48:23 -08:00
Miss Islington (bot) 7a3cbcdc55 Improve readability of random module examples (GH-11884) (GH-11885)
Based on reviewer feedback from Allen Downey, convert ``lambda`` to ``def``.
(cherry picked from commit 9abb725cea)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-02-15 12:47:04 -08:00
Miss Islington (bot) f6097306ff Fix the versionadded info for typing.NoReturn (GH-11880)
The earliest version that `typing.NoReturn` appears in is [3.5.4rc1](https://docs.python.org/3/whatsnew/changelog.htmlGH-python-3-5-4-release-candidate-1)
(cherry picked from commit 903567e4f5)

Co-authored-by: Jack Wilsdon <jack.wilsdon@gmail.com>
2019-02-15 11:31:28 -08:00
Miss Islington (bot) 05f41363d4
bpo-36006: Fix versionchanged directive alignment in io module documentation (GH-11881)
https://bugs.python.org/issue36006
(cherry picked from commit 522630a746)

Co-authored-by: Emmanuel Arias <emmanuelarias30@gmail.com>
2019-02-15 11:09:38 -08:00
Miss Islington (bot) b8bcec35e0
bpo-30410: Documentation of sys.stdin/out/err update to reflect change in 3.6 (GH-10264)
Documentation of sys.stdin/out/err update to reflect change in 3.6 on Windows to use UTF-8.

Wording by Eryk Sun and Paul Moore.

https://bugs.python.org/issue30410
(cherry picked from commit 5723263a3a)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2019-02-14 15:45:20 -08:00
Miss Islington (bot) 2259b5af3c
[3.7] bpo-22062: Updated docstring and documentation for pathlib (GH-8519) (GH-11817)
Original patch by Mike Short


https://bugs.python.org/issue22062
(cherry picked from commit 537b6caa56)


Co-authored-by: Eivind Teig <eivind.teig@gmail.com>


https://bugs.python.org/issue22062
2019-02-11 04:02:57 -08:00
Miss Islington (bot) cb9a1c72c2
Doc sidebar: 3.6 has moved to security-fix mode. (GH-11810)
(cherry picked from commit 9db56fb8fa)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-02-10 13:43:57 -08:00
Miss Islington (bot) 3fcfef357e
bpo-35833: Revise IDLE doc for control codes sent to Shell. (GH-11799)
Add  a code example block.
(cherry picked from commit 8a03ff2ff4)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2019-02-08 20:43:20 -08:00
Miss Islington (bot) 27f6e94d5f
Fix url to core-mentorship mailing list (GH-11775)
(cherry picked from commit e9bc4172d1)

Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
2019-02-06 12:58:00 -08:00
Inada Naoki 21ab7744ae
bpo-20001: update pathlib landing image (GH-11304)
(cherry picked from commit cd90f6a369)
2019-02-05 19:39:42 +09:00
Miss Islington (bot) a2f4c40233 bpo-26256: Document algorithm speed for the Decimal module. (GH-4808) (#11736)
(cherry picked from commit 00e9c55d27)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2019-02-02 15:46:09 +01:00
Miss Islington (bot) 09b66e027b
doc: http: Fix enum name for status code 416 (GH-11689)
(cherry picked from commit d97daebfa6)

Co-authored-by: Phil Jones <philip.graham.jones@googlemail.com>
2019-01-31 02:15:29 -08:00
Inada Naoki 5901444972
bpo-35865: doc: Remove wrong note and directives (GH-11711)
*  note about random dict order
* Remove wrong versionchanged directive
2019-01-31 17:54:55 +09:00
Miss Islington (bot) 03082a836b
bpo-35854: Fix EnvBuilder and --symlinks in venv on Windows (GH-11700)
(cherry picked from commit a1f9a3332b)

Co-authored-by: Steve Dower <steve.dower@microsoft.com>
2019-01-30 14:14:35 -08:00
Miss Islington (bot) e31f8604e6 Document differences between random.choices() and random.choice(). (GH-11703) (GH-11706) 2019-01-30 13:49:23 -08:00
Miss Islington (bot) 7516f265a8
bpo-35835: Add reference to Python 3.7 new breakpoint() function in pdb documentation. (GH-11691)
(cherry picked from commit cf991e653a)

Co-authored-by: João Matos <jcrmatos@gmail.com>
2019-01-30 09:41:51 -08:00
Miss Islington (bot) ebae1ce9c4 bpo-25592: Improve documentation of distutils data_files (GH-9767) (GH-11701)
(cherry picked from commit 598e15d4fe)

Co-authored-by: jdemeyer <J.Demeyer@UGent.be>
2019-01-30 16:56:51 +01:00
Miss Islington (bot) ff27f8145d
Fix typo: class declaration (GH-11678)
(cherry picked from commit dfc8bb987d)

Co-authored-by: nu_no <nuno.an@gmail.com>
2019-01-27 14:25:49 -08:00
Miss Islington (bot) 658ff84496
Clarify U-mode deprecation in open() (GH-11646)
The previous wording could be read as saying that universal
newlines mode itself was deprecated, when it's only the 'U'
character in the mode field that should be avoided.

The update also moves the description of the 'U' mode character
out of the mode table, as the longer explanation was overly
intrusive as a table entry and overshadowed the actually useful
mode characters.
(cherry picked from commit 3171df3414)

Co-authored-by: Nick Coghlan <ncoghlan@gmail.com>
2019-01-27 08:27:58 -08:00
Miss Islington (bot) c2674bf110 bpo-34134: Advise to use imap or imap_unordered when handling long iterables. (gh-8324) (gh-11673)
(cherry picked from commit 3bab40db96)

Co-authored-by: Windson yang <wiwindson@outlook.com>
2019-01-25 13:08:14 +01:00
Miss Islington (bot) 3be19c082b bpo-35781: Changed references to deprecated 'warn' method in logging documentation in favour of 'warning' (GH-11654) (GH-11657)
(cherry picked from commit cda73a5af2)

Co-authored-by: yuji38kwmt <yuji38kwmt@yahoo.co.jp>
2019-01-23 07:43:37 +00:00
Miss Islington (bot) 552478bb10 bpo-35722: Updated the documentation for the 'disable_existing_loggers' parameter (GH-11525) (GH-11655)
(cherry picked from commit f0c743604f)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2019-01-23 07:21:32 +00:00
Miss Islington (bot) ebb08beb08
bpo-23156: Remove obsolete tix install directions (GH-11595)
Tix was deprecated in 3.6 and the doc is wrong.  New users should use ttk.
(cherry picked from commit cf27c06229)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2019-01-17 16:07:10 -08:00
Miss Islington (bot) 6d84071514
Fixes typo in asyncio.queue doc (GH-11581)
Typo fix for method doc, I'm pretty sure coro is meant, because there's no consumer threads for thread-unsafe queue.

Most probably this piece of doc was copied from `queue.Queue`

There's not BPO bug for this, afaik.
(cherry picked from commit 97e12996f3)

Co-authored-by: Slam <3lnc.slam@gmail.com>
2019-01-17 03:58:37 -08:00
Miss Islington (bot) 422db37778
bpo-35486: Note Py3.6 import system API requirement change (GH-11540)
While the introduction of ModuleNotFoundError was fully backwards
compatible on the import API consumer side, folks providing alternative
implementations of `__import__` need to make an update to be
forward compatible with clients that start relying on the new subclass.

https://bugs.python.org/issue35486
(cherry picked from commit cee29b46a1)

Co-authored-by: Nick Coghlan <ncoghlan@gmail.com>
2019-01-17 02:48:15 -08:00
Miss Islington (bot) 0bb6b89115
bpo-35738: Update the example for timer.Timer.repeat(). (GH-11559)
Show correct number of repeats.
(cherry picked from commit 06f8b57212)

Co-authored-by: Henry Chen <tahafut@gmail.com>
2019-01-15 02:49:16 -08:00
Miss Islington (bot) a4aade2cf8
bpo-29707: Document that os.path.ismount() is not able to reliable detect bind mounts. (GH-11238)
(cherry picked from commit 32ebd8508d)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2019-01-15 01:01:15 -08:00
Miss Islington (bot) 678c5c0752
bpo-34512: Document platform-specific strftime() behavior for non-ASCII format strings (GH-8948)
(cherry picked from commit 1cffd0eed3)

Co-authored-by: Alexey Izbyshev <izbyshev@ispras.ru>
2019-01-12 09:27:30 -08:00
Miss Islington (bot) 8a5b1aa98f
bpo-35716: Update time.CLOCK_MONOTONIC_RAW doc (GH-11517)
Document that the time.CLOCK_MONOTONIC_RAW constant
is now also available on macOS 10.12.

Co-authored-by: Ricardo Fraile <rfraile@rfraile.eu>
(cherry picked from commit fd7d539be3)

Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
2019-01-11 05:32:11 -08:00
Miss Islington (bot) b9cd38f928
bpo-32146: Add documentation about frozen executables on Unix (GH-5850)
(cherry picked from commit bab4bbb4c9)

Co-authored-by: Bo Bayles <bbayles@gmail.com>
2019-01-10 10:13:21 -08:00
Miss Islington (bot) 14190000c7 Update bugs.rst (GH-11485)
(cherry picked from commit 91c6158dbc)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-01-09 16:00:12 -07:00
Miss Islington (bot) 2b3db49369
Add example to the documentation for calling unittest.mock.patch with create=True (GH-11056)
(cherry picked from commit d6acf17c05)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2019-01-09 13:50:02 -08:00
Miss Islington (bot) 5d1e0124cf
bpo-35374: Avoid trailing space in hhc file name if found on PATH. (GH-10849)
(cherry picked from commit e61cc481e0)

Co-authored-by: chrullrich <chris@chrullrich.net>
2019-01-07 19:04:14 -08:00
Miss Islington (bot) 902196d867
bpo-35631: Improve typing docs wrt abstract/concrete collection types (GH-11396)
https://bugs.python.org/issue35631
(cherry picked from commit 31ec52a9af)

Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
2019-01-04 06:20:19 -08:00
Miss Islington (bot) 47c035f3ef
bpo-31450: Remove documentation mentioning that subprocess's child_traceback is available with the parent process (GH-11422)
(cherry picked from commit 47a2fced84)

Co-authored-by: Harmandeep Singh <harmandeep3091@gmail.com>
2019-01-03 12:01:44 -08:00
Miss Islington (bot) d7cb2034bb
bpo-35525: Correct the argument name for NNTP.starttls() (GH-11310)
(cherry picked from commit e9a044ec16)

Co-authored-by: Harmandeep Singh <harmandeep3091@gmail.com>
2019-01-02 13:11:00 -08:00
Benjamin Peterson d634abd123
[3.7] Bump copyright years to 2019. (GH-11406)
(cherry picked from commit 9a69ae8a78)
2019-01-02 08:15:53 -08:00
Miss Islington (bot) c74061d49b
Fix typo in documentation of AbstractEventLoopPolicy.set_child_watcher() (GH-11369)
`set_child_watcher()` *sets* the watcher.
(cherry picked from commit 1b29c03c95)

Co-authored-by: sth <sth.dev@tejp.de>
2018-12-30 14:07:05 -08:00
Miss Islington (bot) b716c716b5
bpo-28097: IDLE - Add Previous/Next History to Shell menu (GH-11325)
(cherry picked from commit c0381aaea4)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-12-28 12:29:44 -08:00
Miss Islington (bot) dcf14d1a98
bpo-35579: Fix typo in in asyncio-task documentation (GH-11321)
https://bugs.python.org/issue35579

https://bugs.python.org/issue35579
(cherry picked from commit 3a81076bbf)

Co-authored-by: Vaibhav Gupta <vaibhgupt199@gmail.com>
2018-12-26 06:53:03 -08:00
Miss Islington (bot) 793ebdfc55 Redo PR 785 -- Add cross reference links (GH-11319) (#11320)
(cherry picked from commit 56edf3a4b1)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2018-12-25 18:00:20 -08:00
Miss Islington (bot) 7085150cdc
Minor grammar improvement in types.rst (GH-11308)
defines utility function -> defines utility functions

Reported in https://mail.python.org/pipermail/docs/2018-December/038693.html
(cherry picked from commit 95327bc80d)

Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
2018-12-24 16:41:00 -08:00
Miss Islington (bot) 00a48d57df bpo-34764: improve docs example of iter() with sentinel value (GH-11222) (#11301)
(cherry picked from commit d378b1f8ed)

Co-authored-by: Chris Rands <c_rands100@hotmail.com>
2018-12-23 21:19:57 -08:00
Miss Islington (bot) bc64123335 bpo-35566: Add links to annotation glossary term (GH-11291) (GH-11302) 2018-12-23 21:18:39 -08:00
Miss Islington (bot) a58c8442f1 Document that dict.fromkeys accepts any iterable for keys (GH-10998) (GH-11294)
(cherry picked from commit f06fba5965)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2018-12-22 20:56:01 -08:00
Miss Islington (bot) 48a206978c
bpo-22703: IDLE: Improve Code Context and Zoom Height menu labels (GH-11214)
The Code Context menu label now toggles between Show/Hide Code Context.
 The Zoom Height menu now toggles between Zoom/Restore Height.
 Zoom Height has moved from the Window menu to the Options menu.

https://bugs.python.org/issue22703
(cherry picked from commit c1b4b0f616)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-12-21 22:41:50 -08:00
Miss Islington (bot) aa7922ae79
[3.7] Removed dangling `since Python` at the end of library/xml.rst. (GH-11201) (GH-11231)
(cherry picked from commit 82d73554e4)


Co-authored-by: Jules Lasne (jlasne) <jlasne@student.42.fr>
2018-12-21 10:22:17 -08:00
Miss Islington (bot) 26ab036098
bpo-33830: Fix an example in http.client docs for 404. (GH-7780)
(cherry picked from commit f0af4c54e3)

Co-authored-by: Xtreak <tirkarthi@users.noreply.github.com>
2018-12-21 07:41:01 -08:00
Miss Islington (bot) aae2e85af7
bpo-35482: Fixes HTML escaping in CHM index and build location of NEWS file (GH-11224)
(cherry picked from commit afe17a7bee)

Co-authored-by: Steve Dower <steve.dower@microsoft.com>
2018-12-20 09:27:12 -08:00
Miss Islington (bot) 5d0498a696
bpo-35521: Add more cross-refs to IDLE docs (GH-11257)
Format menu and preferences.
(cherry picked from commit 292cd6e331)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-12-20 03:25:06 -08:00
Miss Islington (bot) 73fc14d1f8
bpo-18085: Update refcounts.dat. (GH-11247)
Fixed some errors in refcounts.dat, remove functions removed in
Python 3, and add more entries for documented functions. This will
add several automatically generated notes about return values.
(cherry picked from commit 83dd4e87a6)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-12-19 23:43:22 -08:00
Miss Islington (bot) 3f93383127
bpo-35521: IDLE: Add code context section to docs (GH-11205)
Also add some internal cross-references.
(cherry picked from commit 01421bec1e)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-12-19 21:59:22 -08:00