Commit Graph

21842 Commits

Author SHA1 Message Date
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
Miss Islington (bot) 29d4e309b1
bpo-32077: Update refcounts.dat for Unicode object functions. (GH-11243)
Makes the documentation more comprehensive in terms of indicating
whether or not a function returns a new reference.

Also fixes some errors and adds missing functions.
(cherry picked from commit b2f642ccd2)

Co-authored-by: Mat M <mathew1800@gmail.com>
2018-12-19 12:03:20 -08:00
Miss Islington (bot) e2e6f907fd
Fix documented signatures for C API functions. (GH-11236)
(cherry picked from commit 57dd79e6f7)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-12-19 05:43:29 -08:00
Miss Islington (bot) a11d44056e
bpo-35497: add versionadded tag for EPOLLEXCLUSIVE (GH-11162)
(cherry picked from commit 92330c0b6d)

Co-authored-by: Manjusaka <lizheao940510@gmail.com>
2018-12-19 04:05:48 -08:00
Julien Palard a9ed8fcdba
bpo-35472: Doc: For Python 3.7 Sphinx 1.6.6 is enough. (GH-11192) 2018-12-19 11:14:55 +01:00
Serhiy Storchaka 1e47fbcf78
[3.7] bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174). (GH-11232)
(cherry picked from commit 2b57c43f21)
2018-12-19 09:28:12 +02:00
Miss Islington (bot) 12f3979b38 bpo-35465: Document _UnixSelectorEventLoop.add_signal_handler. (GH-11145) (GH-11221)
(cherry picked from commit e3666fc8ef)

Co-authored-by: Hrvoje Nikšić <hniksic@gmail.com>
2018-12-18 16:52:37 -05:00
Miss Islington (bot) f265afec1c
bpo-35461: Document C API functions which suppress exceptions. (GH-11119)
(cherry picked from commit 3fcc1e08db)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-12-18 12:24:39 -08:00
Miss Islington (bot) 605ef6e534
bpo-35475: Add more PyImport* functions in refcounts.dat. (GH-11142)
(cherry picked from commit bdabb0737c)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-12-17 07:48:29 -08:00
Miss Islington (bot) c367d52a74
bpo-23451: Update time.monotonic() documentation (GH-11190)
bpo-23451, bpo-22117: Python 3.5 requires Windows Vista or newer,
time.monotonic() is now always system-wide.
(cherry picked from commit 3ab064e80a)

Co-authored-by: Victor Stinner <vstinner@redhat.com>
2018-12-17 03:31:03 -08:00
Miss Islington (bot) d5176fe2bc bpo-35450: reflect in docs that venv module is not always creating a copy of the Python binary (GH-11144) (GH-11167)
https://bugs.python.org/issue35450
(cherry picked from commit f5107dfd42)

Co-authored-by: mkkot <marcin2006@gmail.com>
2018-12-14 12:38:23 -08:00
Miss Islington (bot) 527008599d
Fixed missing colun in library/sys.po (GH-11153)
GH- Fixed missing colun in library/sys.po

[bpo-35492](https://bugs.python.org/issue35492): Fixed missing colun in library/sys.po
(cherry picked from commit cb0f5e29e3)

Co-authored-by: Jules Lasne (jlasne) <jlasne@student.42.fr>
2018-12-14 03:35:55 -08:00
Steve Dower 0e4ad88ff8
bpo-34977: Add Windows App Store package (GH-11027)
Also adds the PC/layout script for generating layouts on Windows.
2018-12-10 19:58:52 -08:00
Miss Islington (bot) b3ffe47bcb
Fix numbered lists in stdtypes.rst. (GH-10989)
(cherry picked from commit de9e9b476e)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2018-12-10 12:51:32 -08:00
Steve Dower b264c60985
[3.7] bpo-34977: Use venv redirector instead of original python.exe on Windows (GH-11029) 2018-12-10 08:11:34 -08:00
Miss Islington (bot) 331bfa4f2c
bpo-22005: Document the reality of pickle compatibility. (GH-11054)
(cherry picked from commit e328753d91)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2018-12-09 11:48:35 -08:00
Julien Palard b6b77955f2 [3.7] Doc: Disable smartquotes for zh-tw, zh-cn, fr and ja translations (GH-9423) (GH-10344)
(cherry picked from commit c03bf0ae79)
2018-12-08 21:56:59 -08:00
Serhiy Storchaka 0d5730e643
[3.7] bpo-22005: Fixed unpickling instances of datetime classes pickled by Python 2. (GH-11017) (GH-11022)
encoding='latin1' should be used for successful decoding.
(cherry picked from commit 8452ca15f4)
2018-12-07 14:56:02 +02:00
Miss Islington (bot) 72c71956ca
Add missing period in distutils.dep_util.newer_group doc (GH-11003)
(cherry picked from commit c9566b8c45)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2018-12-06 13:30:13 -08:00
Miss Islington (bot) f913d44eb7
Clarify expectedFailure in the unittest docs. (GH-10953)
(cherry picked from commit 91f259b478)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2018-12-06 13:16:03 -08:00
Mariatta c28317e4c2 [3.7] Fix typo in xml.dom.minidom documentation (GH-10956) (GH-10961)
Escape the \t and \n.
Follow up from https://github.com/python/cpython/pull/10814..
(cherry picked from commit 2d8f976cde)

Co-authored-by: E Kawashima <e-kwsm@users.noreply.github.com>
2018-12-05 16:24:44 -08:00
Miss Islington (bot) 022d7bc7cc
Fix typos in concurrent.Futures documentation (GH-10920)
Add a missing word `as` in `as well as an`.
Linkify `threading.Thread`.
(cherry picked from commit 40a61da40d)

Co-authored-by: Matt Wheeler <m@funkyhat.org>
2018-12-05 14:17:28 -08:00
Miss Islington (bot) 349d9910b2
Correct a couple of unbalanced parenthesis. (GH-10779)
(cherry picked from commit 55f41e45b4)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2018-12-05 12:15:54 -08:00
Miss Islington (bot) d2c7c1f768
Move __missing__ after __delitem__ in Data model. (GH-10923)
(cherry picked from commit 1ce853f377)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2018-12-05 12:11:16 -08:00
Miss Islington (bot) 6627d3ae1e
bpo-35395: fix typos in asyncio eventloop documentation (GH-10880)
Fixes `loop.add_writer` and `loop.add_signal_handler` method documentation to correctly reference the callback parameter from method signature.

https://bugs.python.org/issue35395
(cherry picked from commit 1747334794)

Co-authored-by: Naglis <naglis@users.noreply.github.com>
2018-12-03 23:36:31 -08:00
Miss Islington (bot) e8f9e4785c bpo-35226: Fix equality for nested unittest.mock.call objects. (GH-10555)
Also refactor the call recording imolementation and add some notes
about its limitations.
(cherry picked from commit 8ca0fa9d2f)

Co-authored-by: Chris Withers <chris@withers.org>
2018-12-03 21:54:44 +00:00
Miss Islington (bot) 6cb0486ce8
bpo-35341: Add generic version of OrderedDict to typing (GH-10850)
(cherry picked from commit 68b56d02ef)

Co-authored-by: Ismo Toijala <ismo.toijala@gmail.com>
2018-12-02 08:14:44 -08:00
E Kawashima 7da9755021 [3.7] Fix signature of xml.dom.minidom.Document.toprettyxml(). (GH-10814). (GH-10824)
(cherry picked from commit b7c2182604)
2018-12-01 14:19:39 +02:00
Miss Islington (bot) 0df1f4576e
Fix typo in Memory Management doc. (GH-10798)
(cherry picked from commit a407004391)

Co-authored-by: Kevin Adler <kadler@us.ibm.com>
2018-11-30 00:05:51 -08:00
Miss Islington (bot) e754159ef0 bpo-16086: Fix PyType_GetFlags() documentation (GH-10758) (GH-10789)
PyType_GetFlags() return type is unsigned long, not long.
(cherry picked from commit 9fbcfc08e5)

Co-authored-by: Eddie Elizondo <eduardo.elizondorueda@gmail.com>
2018-11-29 12:07:33 +01:00
Miss Islington (bot) 24b51b1a49
bpo-34022: Stop forcing of hash-based invalidation with SOURCE_DATE_EPOCH (GH-9607)
Unconditional forcing of ``CHECKED_HASH`` invalidation was introduced in
3.7.0 in bpo-29708.  The change is bad, as it unconditionally overrides
*invalidation_mode*, even if it was passed as an explicit argument to
``py_compile.compile()`` or ``compileall``.  An environment variable
should *never* override an explicit argument to a library function.
That change leads to multiple test failures if the ``SOURCE_DATE_EPOCH``
environment variable is set.

This changes ``py_compile.compile()`` to only look at
``SOURCE_DATE_EPOCH`` if no explicit *invalidation_mode* was specified.
I also made various relevant tests run with explicit control over the
value of ``SOURCE_DATE_EPOCH``.

While looking at this, I noticed that ``zipimport`` does not work
with hash-based .pycs _at all_, though I left the fixes for
subsequent commits.
(cherry picked from commit a6b3ec5b6d)

Co-authored-by: Elvis Pranskevichus <elvis@magic.io>
2018-11-28 09:45:36 -08:00
Julien Palard 9c16bc2c3d [3.7] Doc: Delete "how do I emulate os.kill" section in Windows FAQ (GH-10487) (GH-10767) 2018-11-28 07:53:23 -08:00
Julien Palard 6f8cab0db0 [3.7] bpo-35255: Doc: Delete now useless Windows FAQ section (GH-10557) (GH-10722)
(cherry picked from commit 5719f275b7)

Co-authored-by: Mathieu Dupuy <deronnax@users.noreply.github.com>





https://bugs.python.org/issue35255
2018-11-26 09:05:48 -08:00
Miss Islington (bot) c707400727 bpo-35300: Add usage note to the lru_cache() docs (GH-10707) (GH-10708) 2018-11-25 17:00:37 -08:00
Miss Islington (bot) 89a3087d40
bpo-32035: Fix words about strings and bytes in zipfile documentation. (GH-10592)
(cherry picked from commit 4bb186d7e2)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-11-25 01:30:37 -08:00
Miss Islington (bot) 70cc092340
Linkify SMTP.quit() in smtplib documentation. (GH-9785)
(cherry picked from commit ba57963a95)

Co-authored-by: takey <taketakeyyy@gmail.com>
2018-11-23 08:59:05 -08:00
Miss Islington (bot) df6374e15a
bpo-31146: Don't fallback switcher to english on not-yet pusblished languages. (GH-10558)
(cherry picked from commit 6b73bb523a)

Co-authored-by: Julien Palard <julien@palard.fr>
2018-11-21 14:46:30 -08:00
Miss Islington (bot) 3b7258a5a5 [3.7] bpo-35035: Rename email.utils documentation to email.utils.rst (GH-10023)
I'll watch for 404 on the old URL and will setup an HTTP redirection if needed.
(cherry picked from commit 361e8683e7)

Co-authored-by: Zhiming Wang <github@zmwang.pw>
2018-11-21 13:54:17 +01:00
Miss Islington (bot) d170e594b2 bpo-35221: Additional hint that the placeholder is to be replaced. (GH-10604) (GH-10629)
(cherry picked from commit d936a8f8e0)

Co-authored-by: Julien Palard <julien@palard.fr>
2018-11-21 00:48:57 -08:00
Victor Stinner 6eff6b8eec
bpo-28604: Fix localeconv() for different LC_MONETARY (GH-10606) (GH-10619)
locale.localeconv() now sets temporarily the LC_CTYPE locale to the
LC_MONETARY locale if the two locales are different and monetary
strings are non-ASCII. This temporary change affects other threads.

Changes:

* locale.localeconv() can now set LC_CTYPE to LC_MONETARY to decode
  monetary fields.
* Add LocaleInfo.grouping_buffer: copy localeconv() grouping string
  since it can be replaced anytime if a different thread calls
  localeconv().

(cherry picked from commit 02e6bf7f20)
2018-11-20 22:06:21 +01:00
Miss Islington (bot) f8f9915f95
bpo-9842: Add references for using "..." as a placeholder to the index. (GH-10330)
(cherry picked from commit 6c48bf2d9e)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-11-20 10:07:54 -08:00
Miss Islington (bot) d1a97b3659
[3.7] bpo-25438: document what codec PyMemberDef T_STRING decodes the char * as (GH-10580) (GH-10586)
Source of T_STRING: e42b705188/Python/structmember.cGH-L51

Source of PyUnicode_FromString
https://github.com/python/cpython/blob/master/Include/unicodeobject.hGH-L702


https://bugs.python.org/issue25438
(cherry picked from commit 689d555ec1)


Co-authored-by: Windson yang <wiwindson@outlook.com>


https://bugs.python.org/issue25438
2018-11-17 11:49:58 -08:00
Miss Islington (bot) 0461c3b635
bpo-35250: Correct argument name "num" -> "btn" in turtle docs. (GH-10565)
(cherry picked from commit 4edeaeac4c)

Co-authored-by: Srinivas  Thatiparthy (శ్రీనివాస్  తాటిపర్తి) <thatiparthysreenivas@gmail.com>
2018-11-16 05:55:14 -08:00
Miss Islington (bot) be34cb26b9
Fix outdated info in datamodel about dicts (GH-9807)
(cherry picked from commit a48e0eb967)

Co-authored-by: wim glenn <wim.glenn@gmail.com>
2018-11-16 04:20:03 -08:00
Miss Islington (bot) 1b80a373d1
bpo-33816: Remove outdated metaclass example (GH-7566)
(cherry picked from commit c2ccac7b9f)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-16 03:51:20 -08:00
Miss Islington (bot) 579c417564
bpo-35213: Where appropriate, use 'macOS' in idlelib. (GH-10478)
(cherry picked from commit b65413b497)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-11-15 11:31:31 -08:00
Miss Islington (bot) b6b56b49e9
Fix typo in asynchronous generator iterator documentation (GH-10542)
Remove an unnecessary "that":
... will execute that the body ... ->  ... will execute the body ...
(cherry picked from commit 25221b3283)

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2018-11-14 22:20:16 -08:00
Julien Palard 9053d2f2e0 [3.7] bpo-32613: Update window FAQ (GH-5552). (GH-10544)
(cherry picked from commit 64313478bc)

Co-authored-by: Julien Palard <julien@palard.fr>



https://bugs.python.org/issue32613
2018-11-14 09:17:35 -08:00
Miss Islington (bot) 52fb9f14b1
Grammar corrections in abc.rst (GH-10525)
(cherry picked from commit 8e0b05e2f4)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-13 17:00:36 -08:00
Miss Islington (bot) e7a5be5cb5
Link to property built-in in abc.rst (GH-10526)
(cherry picked from commit bf1355b424)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-13 16:45:11 -08:00
Miss Islington (bot) c30830bbb2
Fix doc typo: Window -> Windows (GH-10508)
(cherry picked from commit daeb3c4c58)

Co-authored-by: l-n-s <supervillain@riseup.net>
2018-11-13 16:18:20 -08:00
Victor Stinner 55b4771d5d
bpo-35229: Deprecate _PyObject_GC_TRACK() (GH-10511)
Deprecate _PyObject_GC_TRACK() and _PyObject_GC_UNTRACK() in the
documentation. These macros are removed from Python 3.8 by the commit
1a6be91e6f.
2018-11-13 13:06:11 +01:00
Miss Islington (bot) 5e4a13b18b
Fix a couple documentation typos. (GH-10498)
reproduciblity -> reproducibility
PyPA are the group -> PyPA is the group
(cherry picked from commit 0dc1e45dfd)

Co-authored-by: Windson yang <wiwindson@outlook.com>
2018-11-12 20:20:31 -08:00
Miss Islington (bot) f3b0b91674
Improve grammar in Glossary. (GH-10474)
a asynchronous generator -> an asynchronous generator
(cherry picked from commit a9655b7f71)

Co-authored-by: Windson yang <wiwindson@outlook.com>
2018-11-12 09:48:11 -08:00
Miss Islington (bot) 8a54c67701
Correct grammar mistake in stdtypes.rst (GH-10481)
(cherry picked from commit 7610f4fe93)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-12 09:45:05 -08:00
Miss Islington (bot) 5e51f120c0
Linkify PEP 8 in unix.rst (GH-10482)
(cherry picked from commit 9404e7737b)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-12 08:48:56 -08:00
Miss Islington (bot) a744abcb59
Minor grammar improvement to io documentation. (GH-10329)
Independently of -> Independent of
(cherry picked from commit cd449806fa)

Co-authored-by: Srinivas  Thatiparthy (శ్రీనివాస్  తాటిపర్తి) <thatiparthysreenivas@gmail.com>
2018-11-11 20:29:33 -08:00
Miss Islington (bot) 7a90504261
Update subprocess.Popen documentation wrt universal_newlines arg (GH-10337)
* universal_newlines defaulting to False would suggest, that not
  specifying universal_newlines explicitly and setting text to True
  should cause an error, which is not the case.
* The run function didn't have the universal_newlines parameter
  documented
* The check_output function didn't have its text parameter documented
(cherry picked from commit 7432f0929f)

Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
2018-11-11 19:48:09 -08:00
Miss Islington (bot) aa493b5c18 bpo-33878: Doc: Fix missing case by simplifying. (GH-7762)
The documentation was not covering multiple targets enclosed by
parenthesis nor multiple targets enclosed by brackets, adding them all
would be heavy, an else cover them all and is lighter to read.
(cherry picked from commit 082875dcd6)

Co-authored-by: Julien Palard <julien@palard.fr>
2018-11-12 01:24:31 +01:00
Miss Islington (bot) 7d7ff672df
bpo-33699: Describe try's else clause with the rest of the try clause (GH-7252)
https://bugs.python.org/issue33699
(cherry picked from commit b086c8afdb)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-11 11:43:52 -08:00
Miss Islington (bot) 317dbb4433
dict insertion order is guaranteed since 3.7 (GH-10431)
(cherry picked from commit 76e8fd7b7e)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-11 09:02:11 -08:00
Miss Islington (bot) b91c27d89d
bpo-34864: Document two IDLE on MacOS issues. (GH-10456)
The System Preferences Dock "prefer tabs always" setting disables some
IDLE features.  Menus are a bit different than as described for Windows
and Linux.
(cherry picked from commit 50ff02b431)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-11-10 20:46:12 -08:00
Miss Islington (bot) 3da64a0141
Correct a typo in the Unittest documentation (GH-10397)
Co-Authored-By: maggyero <gery.ogam@gmail.com>
(cherry picked from commit 009b2f0204)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2018-11-09 11:43:43 -08:00
Miss Islington (bot) 33fd60d4c3 Cleanup and improve the regex tokenizer example. (GH-10426) (#10427)
1) Convert weird field name "typ" to the more standard "type".
2) For the NUMBER type, convert the value to an int() or float().
3) Simplify ``group(kind)`` to the shorter and faster ``group()`` call.
4) Simplify logic go a single if-elif chain to make this easier to extend.
5) Reorder the tests to match the order the tokens are specified.
   This isn't necessary for correctness but does make the example
   easier to follow.
6) Move the "column" calculation before the if-elif chain so that
   users have the option of using this value in error messages.
(cherry picked from commit b83942c755)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2018-11-09 01:26:55 -08:00
Julien Palard 732f745a4a [3.7] Doc: Make all versions sidebars the same for consistency. (GH-10288) (GH-10409) 2018-11-08 00:07:05 -08:00
Miss Islington (bot) 363839caf9
bpo-35015: Doc: Fix internationalisation of the availability directive. (GH-10360)
(cherry picked from commit beed84ca5e)

Co-authored-by: Julien Palard <julien@palard.fr>
2018-11-07 13:48:47 -08:00
Miss Islington (bot) e40e205498
Add link to PEP 525 in Expressions. (GH-10333)
(cherry picked from commit bfe1839aa9)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-07 10:32:05 -08:00
Miss Islington (bot) 38bdaa47cf
glob uses fnmatch.filter instead of fnmatch since 2001. (GH-10102)
(cherry picked from commit ae31e3fbf4)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-07 10:30:18 -08:00
Miss Islington (bot) b949f74f4b
Add a reference to the name mangling description in the tutorial to the index. (GH-10138)
(cherry picked from commit c5eec4426d)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-07 10:29:58 -08:00
Miss Islington (bot) 2911d4eb21
Add future_stmt to simple_stmt production list. (GH-8239)
(cherry picked from commit cdb96f45b6)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-07 09:55:14 -08:00
Miss Islington (bot) 766d8f560d
Correct grammar mistakes in string.rst. (GH-9752)
(cherry picked from commit d64991031e)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-07 09:54:55 -08:00
Miss Islington (bot) f455dd53af
Mark len call as a code snippet in stdtypes.rst. (GH-9804)
(cherry picked from commit ca03f3b93e)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-07 09:54:41 -08:00
Miss Islington (bot) 76023169f0
Mark -c and -O as command line options in reStructuredText. (GH-10103)
(cherry picked from commit ea6a28c9f7)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-07 09:53:20 -08:00
Miss Islington (bot) 2b2a8c130c
bpo-33000: Document that IDLE's shell has no line limit. (GH-10373)
A program that runs indefinitely can overfill memory.
(cherry picked from commit 76cd0c30d6)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-11-06 21:06:54 -08:00
Miss Islington (bot) 34fcee9ed8
bpo-23220: Explain how IDLE's Shell displays output (GH-10356)
Add a new subsection to the doc.
(cherry picked from commit 75d9d59ab3)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-11-06 10:27:20 -08:00
Miss Islington (bot) a437c285fa
bpo-35099: Improve the doc about IDLE running user code. (GH-10350)
The section is renamed from "IDLE -- console differences".  It mostly
covers the implications of using custom sys.stdxxx objects.
(cherry picked from commit 5e79090324)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-11-05 18:35:18 -08:00
Miss Islington (bot) 558dc8adbe
bpo-35119: Fix RecursionError in example of customizing module attribute access. (GH-10323)
https://bugs.python.org/issue35119
(cherry picked from commit 0bee3c36d4)

Co-authored-by: Denis Osipov <osipov_d@list.ru>
2018-11-05 17:59:15 -08:00
Miss Islington (bot) 91a19c923c
[Docs] Fix required version of an example of importlib (GH-10118)
§31.5.6.3. Importing a source file directly: `module_from_spec` is new in Python 3.5.
(cherry picked from commit 16c8a53490)

Co-authored-by: E Kawashima <e-kwsm@users.noreply.github.com>
2018-11-05 14:46:42 -08:00
Serhiy Storchaka 6ad277b259
[3.7] bpo-35167: Specify program for json.tool command line options. (GH-10332) (GH-10338)
(cherry picked from commit 083a7a172b)
2018-11-05 18:44:08 +02:00
Miss Islington (bot) 133fd6527d
Fix a typo about a comma. (GH-10306)
(cherry picked from commit fe62d877e3)

Co-authored-by: İsmail Arılık <arilik.ismail@gmail.com>
2018-11-03 10:41:38 -07:00
Miss Islington (bot) b9c48a73bc
Include memo in the documented signature of copy.deepcopy()
* Include memo in the documented signature of copy.deepcopy()

The memo argument is mentioned lower on the doc page under writing a
`__deepcopy__` method, but is not included in the documented function signature.
This makes it easy to miss, and can lead to incorrect/buggy implementations of
`__deepcopy__` -- which is exatly what just happpend to me!
(cherry picked from commit 0200928e8d)

Co-authored-by: Stephan Hoyer <shoyer@gmail.com>
2018-11-01 14:35:17 -07:00
Miss Islington (bot) d69f015ba5
Doc: fix asyncio loop.close() description (GH-10229)
Needs backport to 3.7. In 3.6 the description is correct.
(cherry picked from commit b83d917faf)

Co-authored-by: Andriy Maletsky <andriy.maletsky@gmail.com>
2018-11-01 14:34:42 -07:00
Miss Islington (bot) 7d35553138
bpo-35075: Fix broken url in the pprint documentation (GH-10201)
https://bugs.python.org/issue35075
(cherry picked from commit bf46a09dec)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2018-11-01 14:33:52 -07:00
Serhiy Storchaka b183750f99
[3.7] bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231). (GH-10253)
(cherry picked from commit 3f819ca138)
2018-10-31 11:00:24 +02:00
matthewbelisle-wf aa0a21a7c8 bpo-35116, urllib.parse: Document the new max_num_fields parameter (GH-10246) 2018-10-30 22:15:24 +01:00
Miss Islington (bot) f51ef51db6
bpo-35086: Fix tkinter example "A Simple Hello World Program". (GH-10160)
The root widget was accessed as a global variable in the Application's method.
(cherry picked from commit a80af77087)

Co-authored-by: Daniel Lovell <lovell.daniel92@gmail.com>
2018-10-30 08:34:54 -07:00
Miss Islington (bot) a02bc719eb
bpo-27741: Better wording for datetime.strptime() (GH-9994)
(cherry picked from commit c0799ec973)

Co-authored-by: Gus Goulart <augusto@goulart.me>
2018-10-29 04:55:08 -07:00
Miss Islington (bot) 1a3f18e2c5
bpo-35097: Add IDLE doc subsection explaining editor windows. (GH-10206)
Topics include opening, title and status bar, .py* extension, and running.
(cherry picked from commit ea9c8bd443)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-10-28 18:51:33 -07:00
Miss Islington (bot) ff8d626f3a
Issue 35093: Document the IDLE document viewer in the IDLE doc. (GH-10195)
Add a paragraph in "Help and preferences", "Help sources" subsection.
(cherry picked from commit 18032632ab)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-10-28 13:39:38 -07:00
Miss Islington (bot) 8dccb00c19
bpo-1529353: Explain Shell text squeezing in the IDLE doc. (GH-10169)
(cherry picked from commit 68d6dc0770)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-10-28 10:03:19 -07:00
Miss Islington (bot) fdf48b6b88 bpo-35054: Add yet more index entries for symbols. (GH-10121) (GH-10171)
(cherry picked from commit 913876d824)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-10-28 18:43:32 +02:00
Miss Islington (bot) c516dc6e57
bpo-35089: Don't mention typing.io and typing.re (GH-10173)
https://bugs.python.org/issue35089
(cherry picked from commit c8a8d6b347)

Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
2018-10-28 09:16:36 -07:00
Miss Islington (bot) 50e04cc273
Fix mistakes on function coroutines related definitions (GH-9871)
Fix a bug I introduced in GH-9864 by which coroutines are treated as synonymous of function coroutines.

Also, fix the same mistake (coroutines == function coroutines) already present in other parts of the reference.

I'm very sorry for the hassle.
(cherry picked from commit 95f68b10d5)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-10-28 06:52:27 -07:00
Miss Islington (bot) c73cd4e05a Fix typo in zipfile documentation. (GH-10151) (GH-10153)
(cherry picked from commit 40bf6cff22)

Co-authored-by: nsrip <nick.ripley@me.com>
2018-10-27 23:06:46 +03:00
Miss Islington (bot) 6f82bdc6e0
unittest documentation: Spell pytest without the dot (GH-9820)
Referring to ``pytest`` as ``py.test`` is deprecated.
(cherry picked from commit d855f2fdbd)

Co-authored-by: Andreas Pelme <andreas@pelme.se>
2018-10-27 11:17:15 -07:00
Miss Islington (bot) cb920c1442
bpo-35079: Revise difflib.SequenceManager.get_matching_blocks doc (GH-10144)
Specify that blocks are non-overlapping. Change '!=' to '<'.
(cherry picked from commit d9bff4e81b)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-10-26 20:07:42 -07:00
Miss Islington (bot) f2b5b4f259
Fix a typo in asyncio-dev.rst. (GH-10133)
"threadsafe"
(cherry picked from commit 4e3a53bcee)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2018-10-26 10:42:49 -07:00
Senthil Kumaran bb1876acd8
[3.7] bpo-34576 : Backport eeab510 (#10114)
* bpo-34576 - Fix the formatting for security considerations in http.server.rst (#10005)

(cherry picked from commit eeab510bb7)
2018-10-26 10:11:39 -07:00
Andrés Delfino 1487b651ca [3.7] bpo-34789: xml.sax.make_parser expects a list not just any sequence (GH-9542) 2018-10-26 16:12:02 +03:00
Miss Islington (bot) ec10b70ea6
bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)
(cherry picked from commit e483f02423)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-10-26 03:56:28 -07:00
Serhiy Storchaka 9a75b8470a
[3.7] bpo-35054: Add more index entries for symbols. (GH-10064). (GH-10120)
(cherry picked from commit ddb961d2ab)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-10-26 11:18:42 +03:00
Miss Islington (bot) c64c4056c1
bpo-35038: AttributeError: 'frame' object has no attribute 'f_restricted'. (GH-10098)
https://bugs.python.org/issue35038
(cherry picked from commit 1770d1c512)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-10-25 14:19:31 -07:00
Miss Islington (bot) b322394009
configparser doc: Properly label ConfigParser attributes (GH-9930)
(cherry picked from commit 890423f796)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2018-10-24 16:56:25 -07:00
Miss Islington (bot) 917efd8d7b
importlib doc: Fix approximated import_module() code (GH-9945)
The spec gets stored on modules with the __spec__ attribute, not spec.
(cherry picked from commit 78401f7156)

Co-authored-by: orlnub123 <orlnub123@gmail.com>
2018-10-24 16:38:00 -07:00
Miss Islington (bot) f2679afda0
bpo-35027, distutils doc: Correct note on setup.py change in Python 3.7 (GH-10032)
(cherry picked from commit e80e77a484)

Co-authored-by: TilmanK <tilman.krummeck@googlemail.com>
2018-10-24 15:59:15 -07:00
Miss Islington (bot) d9dbb864cd
Use f-strings in asyncio-task code examples (GH-10035)
Replace str.format with f-strings in the code examples of asyncio-task documentation.
(cherry picked from commit 9f43fbbd9d)

Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
2018-10-24 15:45:44 -07:00
Tal Einat b4c9874f5c [3.7] bpo-33899: Mention tokenize behavior change in What's New (GH-10073) (GH-10074)
(cherry picked from commit dfba1f67e7)


https://bugs.python.org/issue33899
2018-10-24 00:33:00 -07:00
Zsolt Cserna 861f61b5a9 [3.7] bpo-34260, shutil: fix copy2 and copystat documentation (GH-8523) (GH-10065)
Fix the documentation of copy2, as it does not copy file ownership (user and
group), only mode, mtime, atime and flags.

The original text was confusing to developers as it suggested that this
command is the same as 'cp -p', but according to cp(1), '-p' copies file
ownership as well.

Clarify which metadata is copied by shutil.copystat in its docstring.

(cherry picked from commit 4f399be0e7)
2018-10-23 23:57:55 +02:00
Miss Islington (bot) fc62c7223e
bpo-34748: link to :ref:`partial-objects` in functools.partial doc. (GH-9809)
(cherry picked from commit 83a07652e0)

Co-authored-by: Andrei Petre <p31andrei@gmail.com>
2018-10-22 23:16:42 -07:00
Ned Deily 08eae4fa4c Python 3.7.1
-----BEGIN PGP SIGNATURE-----
 
 iQIzBAABCgAdFiEEDZbfTUEQ5cQ/v7F/LTR+pqplQh0FAlvKxbwACgkQLTR+pqpl
 Qh1gIxAAs6/Ry7GirNwzVrKv6HG/GYFB61OaqmO2BMRRuFB226iQjdM1Amaw5I3m
 Dbe4rPrQWXPaI7UIMrbA/oK1BH5AZgpKcVr5YbXF3uAb3AN05E9iNGVbR+qQMlsd
 +3ydWrDcKzRJnVZxaUlLVZdEpaDXsAkAJTfOBNvwdfncBtPXa1+tbuT0SY6yGFwb
 NNq+BvYZJJKuWQ3s10zv5dnUiUlLJMLiVP0pZjwVS2d/gG2gs/rEzz2fBJKygjYR
 TTGhS69KGpqYOLq9USmUzI7DJNts7YeNhhiwF/X7qOx4y2n2dRz721SGlG+Nkxt6
 kvRv3LaLRKsBlPjoVHFyRwIlr4uc3JfwFL3ngswfUNgChrqxkEZgV4oouxeSVQ5o
 Yi/GGBA+c9xvdgufnaKgt8Ep30XRS7vfQZ8KeFwH2xWNCIglVHdBffwwlbwUWft5
 t3/udHDXdeUu7Yb7hfamaA5pafH5lwoQMlbSwOl9gg94sNNuERhocoi8IpMDhzDs
 cI7Jw8sAPWipn6F7k2rn8Z8RFWZEJr4XtgZs/+jTxS3DVfuV3EDYIlM2V/4SXK/b
 KCJ/4NqDjGEFyrSZ0/d5GnmE3dvWrYztUebotFvv2q2aPEv9u8n66BxH/pSLNFTJ
 CtITqOsRwU8IdeOIET0246Oi8Ha4ZU/qQdnPqv5bktD69qAxSOQ=
 =qLkl
 -----END PGP SIGNATURE-----

Merge tag 'v3.7.1' into 3.7
2018-10-20 12:54:48 -04:00
Miss Islington (bot) 34a5ed5c0a
bpo-35032: Remove inaccessible videos from faq/Windows (GH-10004)
https://bugs.python.org/issue35032
(cherry picked from commit d262250d07)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-10-20 08:32:28 -07:00
Ned Deily 32fe7b0188 bpo-34576: Revert doc change until it can be properly fixed (GH-9720)
This reverts commit 57038bcb24.
2018-10-20 00:49:35 -04:00
Miss Islington (bot) 557a68789b
bpo-32798: Add restriction on the offset parameter for mmap.flush in the docs (GH-5621)
Add restriction on the offset parameter for mmap.flush.

Explain that ALLOCATIONGRANULARITY is the same as PAGESIZE in Unix.
(cherry picked from commit 027664a3d5)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2018-10-19 17:48:05 -07:00
Miss Islington (bot) 3e5bcd12f6
bpo-21196: Clarify name mangling rules in tutorial (GH-5667)
Initial patch by Chandan Kumar.
(cherry picked from commit 13ae4d4438)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
2018-10-19 17:41:56 -07:00
Miss Islington (bot) 2a6cf44680
bpo-33726, doc: Add short descriptions to PEP references in seealso (GH-7294)
(cherry picked from commit 0f14fc1a7c)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-10-19 16:43:55 -07:00
Miss Islington (bot) 76d31a3b96
queue doc: Clarify that the simple FIFO queue is SimpleQueue (GH-8372)
(cherry picked from commit acef69068f)

Co-authored-by: Julien Palard <julien@palard.fr>
2018-10-19 15:33:36 -07:00
Miss Islington (bot) 984a800e08
unittest.mock doc: Fix references to recursive seal of Mocks (GH-9028)
The docs in `library/unittest.mock` have been updated to remove
confusing terms about submock and be explicit about the behavior
expected.
(cherry picked from commit 96200eb2ff)

Co-authored-by: Mario Corchero <mariocj89@gmail.com>
2018-10-19 15:17:31 -07:00
Miss Islington (bot) 2bc1e8c909 In email docs, correct spelling of foregoing (GH-9856) (#9919)
(cherry picked from commit c984d20ec8)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-10-18 20:17:25 -04:00
Miss Islington (bot) 8ba831f847 In email.parser in message_from_bytes, update `strict` to `policy` (GH-9854) (#9917)
According to the versionchanged note, the `strict` argument was removed in 3.3 and `policy` was added, but the name of the argument in the paragraph wasn't updated.
(cherry picked from commit a5ca98537b)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-10-18 20:16:16 -04:00
Miss Islington (bot) 6802964fb4 Updated documentation on logging.debug(). (GH-9946) (GH-9949)
(cherry picked from commit bbd90e4f62)

Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2018-10-18 11:55:15 +01:00
Miss Islington (bot) 514bbfc7fc
bpo-34967: Sphinx is deprecating add_description_unit, use add_object_type (GH-9827)
(cherry picked from commit e385d0661e)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-10-15 23:46:38 -07:00
Miss Islington (bot) 802de12d99
bpo-23554: Change echo server example class name from EchoServerClientProtocol to EchoServerProtocol (GH-9859)
(cherry picked from commit 43a5bd7b45)

Co-authored-by: Braden Groom <braden.groom@gmail.com>
2018-10-15 14:59:49 -07:00
Cheryl Sabella b248a8c9a5 [3.7] bpo-11233: Create availability directive for documentation (GH-9692) (GH-9830)
Replace "Availability: xxx" with ".. availability:: xxx" in the doc.
 Original patch by Georg Brandl.

 Co-Authored-By: Georg Brandl <georg@python.org>
 (cherry picked from commit 2d6097d027)

 Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-10-15 22:52:26 +02:00
Miss Islington (bot) c804a5975d fix dangling keyfunc examples in documentation of heapq and sorted (GH-1432)
* fix dangling mention of key=str.lower in heapq doc

* Fix dangling mention of keyfunc example for sorted()
(cherry picked from commit 6bdb6f7675)

Co-authored-by: Wolfgang Maier <wolfgang.maier@biologie.uni-freiburg.de>
2018-10-15 13:19:08 -06:00
Miss Islington (bot) 91b863d93b Update compound_stmts.rst (GH-9864) (GH-9869)
(cherry picked from commit c8bb467f40)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-10-14 11:32:58 +03:00
Miss Islington (bot) d4ed8809dd
bpo-34203: FAQ now recommends python 3.x over 2.x (GH-9796)
(cherry picked from commit 4505f65ae7)

Co-authored-by: Gus Goulart <augusto@goulart.me>
2018-10-12 05:06:07 -07:00
Miss Islington (bot) 57038bcb24
bpo-34576 warn users on security for http.server (GH-9720)
It was proposed to add an warning for http.server regarding security
issues. The wording was provided at bpo-26005 by @orsenthil
(cherry picked from commit 1d26c72e6a)

Co-authored-by: Felipe Rodrigues <felipe@felipevr.com>
2018-10-10 20:55:34 -07:00
Stéphane Wirtel a4910c2498 [3.7] bpo-34906: Doc: Fix typos (2) (GH-9735)
(cherry picked from commit 683281f536)
2018-10-10 15:39:17 +02:00
Miss Islington (bot) c4c86fad80
bpo-32174: Let .chm document display non-ASCII characters properly (GH-9758)
Let .chm document display non-ASCII characters properly

Escape the `body` part of .chm source file to 7-bit ASCII, to fix visual effect on some MBCS Windows systems.
(cherry picked from commit 6261ae9b01)

Co-authored-by: animalize <animalize@users.noreply.github.com>
2018-10-08 14:26:55 -07:00
Miss Islington (bot) c59e75ccf0
bpo-34901: add isolated (-I) flag to sys.flags (GH-9708)
https://bugs.python.org/issue34901
(cherry picked from commit 656d52dbfd)

Co-authored-by: Danish Prakash <grafitykoncept@gmail.com>
2018-10-07 09:18:20 -07:00
Miss Islington (bot) 1a2189353f bpo-34334: Don't log traceback twice in QueueHandler (GH-9537) (GH-9581)
(cherry picked from commit d345bb4d9b)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-10-07 00:33:37 -04:00
Miss Islington (bot) 4322b8dd0f
Correct grammar mistake in re.rst. (GH-9745)
(cherry picked from commit 7dfbd49671)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-10-06 12:56:45 -07:00
Miss Islington (bot) 0991b9bb94 [3.7] bpo-34158: Documentation UTC offset update (GH-8377) (GH-9732)
* Documentation of UTC offset update
Since changes in the UTC offset that allows sub-minute offsets, the documentation needs update:

- "%z" format code documentation update
Karthikeyan Singaravelan commented on bugs.python.org:
Added as part of 018d353c1c and a fix regarding duplicate words for that part was added at bac2d5ba30.
Relevant format string at https://github.com/python/cpython/pull/2896/filesGH-diff-25e2d173c84057d069b7890450714eddR214.
Relevant test case with 6-digit string for microsecond : https://github.com/python/cpython/pull/2896/filesGH-diff-acc40bec51c7de832de3361db3edae52R309.
Table at https://docs.python.org/3.7/library/datetime.htmlGH-strftime-and-strptime-behavior could also be updated with microseconds being optional in the second column
%z | UTC offset in the form ±HHMM[SS] (empty string if the object is naive). | (empty), +0000, -0400, +1030

- isoformat documentation update
According to me, needs confirmation:
Relevant format string at https://github.com/python/cpython/pull/4699/filesGH-diff-25e2d173c84057d069b7890450714eddR176
Relevant test case at https://github.com/python/cpython/pull/4699/filesGH-diff-25e2d173c84057d069b7890450714edd

* From Martin Panter: some style improvment;
From @pganssle: using f for fractional part of seconds in all file.
(cherry picked from commit 92878829c3)

Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
2018-10-05 22:44:23 -04:00
Miss Islington (bot) 2fcaaaca52 [3.7] Make it clear that the msg argument to assertWarns/assertWarnsRegex/assertRaisesRegex is keyword-only. (GH-9680) (GH-9681)
A follow up to be4e5b8920.
(cherry picked from commit e006b39a40)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2018-10-05 22:39:47 -04:00
Andrés Delfino b38ff71501 Fix markup for xml.sax in 3.7.rst (GH-9604) 2018-10-05 22:37:14 -04:00
Miss Islington (bot) 414d58f745 Clarify that AsyncExitStack works with coroutine functions (GH-9405) (GH-9408)
The docs were ambiguous about whether you pass in a coroutine function
or a coroutine object, e.g. is it:

  aestack.push_async_exit(some_async_func)

or

  aestack.push_async_exit(some_async_func())

(It's the first one.)
(cherry picked from commit a3c88ef12c)

Co-authored-by: Nathaniel J. Smith <njs@pobox.com>
2018-10-05 22:29:17 -04:00
Miss Islington (bot) 29c40c7314 bpo-34825: Add more entries to os to pathlib reference table (GH-9608) (#9717)
The added functions are as below :

| os module     | Pathlib       |
| ------------- | ------------- |
| os.chmod   | Path.chmod  |
| os.mkdir  | Path.mkdir  |
| os.rename | Path.rename |
| os.replace | Path.replace |
| os.rmdir  | Path.rmdir |
| os.remove, os.unlink | Path.unlink |
| os.path.samefile | Path.samefile |

Thanks

https://bugs.python.org/issue34825
(cherry picked from commit 6f9c55d1c0)

Co-authored-by: Xtreak <tirkarthi@users.noreply.github.com>
2018-10-05 19:06:17 +03:00
Miss Islington (bot) b3c4a050b7
bpo-34906: Doc: Fix typos (GH-9712)
(cherry picked from commit 07fbbfde1b)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-10-05 07:35:18 -07:00
Miss Islington (bot) 484c899a5b
Make it clear that the msg argument to assertRaises is keyword-only. (GH-9670)
(cherry picked from commit be4e5b8920)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2018-10-01 22:32:01 -07:00
Miss Islington (bot) 27d7f93f63 bpo-31865: Fix a couple of typos in the html.unescape() docs. (GH-9663)
(cherry picked from commit 30534cc717)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2018-10-01 17:43:54 -07:00
Miss Islington (bot) 655608a111 bpo-34476: Document that asyncio.sleep() always suspends. (GH-9643) (#9654)
(cherry picked from commit cd602b8af2)

Co-authored-by: Hrvoje Nikšić <hniksic@gmail.com>
2018-10-01 13:19:33 +03:00
Miss Islington (bot) b0b8f9bd4e bpo-27351: Fix ConfigParser.read() documentation and docstring (GH-8123)
Switch "list" with "iterable" to match with the implementation.
(cherry picked from commit e45473e3ca)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2018-09-29 10:33:05 -06:00
Miss Islington (bot) 4c1b2ad44f
Fix astuple in dataclasses documentation (GH-9631)
(cherry picked from commit 508d820512)

Co-authored-by: 방성범 (Bang Seongbeom) <bangseongbeom@hotmail.com>
2018-09-29 03:55:14 -07:00
Miss Islington (bot) 85ccedc5b5
bpo-34802: Fix asyncio.iscoroutine() docs (GH-9611)
(cherry picked from commit 59ee5b1293)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-27 12:53:18 -07:00
Andrés Delfino 273fc220b2 Fix markup for xml.sax entry in 3.7.1 notes (GH-9602) 2018-09-27 11:25:47 -04:00
Miss Islington (bot) 4ea64a25c2
Clarify that Type[SomeTypeVar] is legal (GH-9585)
Currently, the docs state that when doing `Type[X]`, X is only allowed to
be a class, a union of classes, and Any. This pull request amends
that sentence to clarify X may also be a typevar (or a union involving
classes, Any, and TypeVars).
(cherry picked from commit 130717fe58)

Co-authored-by: Michael Lee <michael.lee.0x2a@gmail.com>
2018-09-26 08:21:15 -07:00
Yury Selivanov 22a56958e7
[3.7] asyncio/docs: Replace Python 4.0 -> 3.10 (GH-9580) 2018-09-25 18:00:15 -04:00
Miss Islington (bot) 3cc9557d9f
bpo-34790: [docs] Passing coroutines to asyncio.wait() can be confusing. (GH-9543)
(cherry picked from commit 996859a90d)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-25 11:57:49 -07:00
Miss Islington (bot) 3637e68d7c
bpo-1529353: IDLE - Squeezer What's New for 3.7.1 (GH-9568)
(cherry picked from commit ea718d377d)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-09-25 09:17:57 -07:00
Miss Islington (bot) 92ad2612be
bpo-1529353: IDLE: Squeezer What's New for 3.6.7 (GH-9567)
(cherry picked from commit dac712d516)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-09-25 09:15:14 -07:00
Miss Islington (bot) bbdf872332
Fix wrong exception reference: BrokenThreadPool -> BrokenProcessPool (GH-9533)
(cherry picked from commit b60b4683f6)

Co-authored-by: Joni Kähärä <joni.kahara@gmail.com>
2018-09-24 20:35:46 -07:00
Christophe Nanteuil 881ddffbff [3.7]Documentation minor update related to 3.6 - 3.7 migration (GH-9501)
Change version from 3.6 to 3.7 in the documentation when it addresses newcomers.

original request from python/python-docs-fr#273
2018-09-24 09:33:44 -07:00
Christian Heimes 394e55a927 [3.7] bpo-17239: Disable external entities in SAX parser (GH-9217) (GH-9511)
The SAX parser no longer processes general external entities by default
to increase security. Before, the parser created network connections
to fetch remote files or loaded local files from the file system for DTD
and entities.

Signed-off-by: Christian Heimes <christian@python.org>

https://bugs.python.org/issue17239.
(cherry picked from commit 17b1d5d4e3)

Co-authored-by: Christian Heimes <christian@python.org>



https://bugs.python.org/issue17239
2018-09-24 05:38:37 -07:00
Christian Heimes 2756ef3165 [3.7] bpo-34670: Add TLS 1.3 post handshake auth (GH-9460) (GH-9505)
Add SSLContext.post_handshake_auth and
SSLSocket.verify_client_post_handshake for TLS 1.3 post-handshake
authentication.

Signed-off-by: Christian Heimes <christian@python.org>q

https://bugs.python.org/issue34670.
(cherry picked from commit 9fb051f032)

Co-authored-by: Christian Heimes <christian@python.org>



https://bugs.python.org/issue34670
2018-09-23 00:22:52 -07:00
Ethan Furman 0c076caaa8
[3.7] bpo-29577: Enum: mixin classes don't mix well with already mixed Enums (GH-9328) (GH-9486)
* bpo-29577: allow multiple mixin classes
2018-09-21 22:26:32 -07:00
Miss Islington (bot) e45662c28b bpo-33649: Fix gather() docs; fix title; few other nits. (GH-9475) (GH-9481)
(cherry picked from commit db1a80e97a)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-21 16:35:34 -04:00
Miss Islington (bot) 914086aa2f
Make docs of exitcode for subprocess.getstatusoutput more clear. (GH-9477)
Make it more accurate and not limited to UNIX.
(cherry picked from commit 7d161726e4)

Co-authored-by: Xiang Zhang <angwerzx@126.com>
2018-09-21 13:34:46 -07:00
Miss Islington (bot) 187f2dd256
bpo-34762: Fix contextvars C API to use PyObject* pointer types. (GH-9473)
(cherry picked from commit 2ec872b31e)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-21 12:48:10 -07:00
Miss Islington (bot) 8e5ef58c10
bpo-33649: More improvements (GH-9439)
(cherry picked from commit e247b46cba)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-20 09:57:19 -07:00
Miss Islington (bot) 4fe8dc6857
bpo-34746: Fix stop -> close (GH-9437)
(cherry picked from commit ffef50f1f5)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-19 22:21:08 -07:00
Yury Selivanov 581890cda3
bpo-34733: Return of the docs search bar (GH-9431)
Partially revert changes to Doc/tools/templates/layout.html
accidentally committed in 512d710109.
2018-09-19 17:51:17 -04:00
Miss Islington (bot) d9c89111bd
bpo-34712: Fix style in examples in "Input and Output" (GH-9361)
A couple of fixes here to make this more PEP-8:

* Avoid multiple statements on one line with `;` statement separator -- this is very rare in Python and is "generally discouraged" in PEP 8 (and if used, per PEP 8 there shouldn't be a space before the `;`)
* Add output for the first "Formatted String Literals" example. (Side note: are the doctests for this being run? If so, why didn't it fail?)
* Avoid space before `!r`. I have generally not seen spaces before the `!`, and this also matches the style used in the docs here: https://docs.python.org/3/library/string.htmlGH-format-string-syntax

https://bugs.python.org/issue34712
(cherry picked from commit 3705b98620)

Co-authored-by: Ben Hoyt <benhoyt@gmail.com>
2018-09-19 13:30:40 -07:00
Victor Stinner 95cc3ee00c
Revert "[3.7] bpo-34589: Add -X coerce_c_locale option; C locale coercion off by default (GH-9379)" (GH-9416)
This reverts commit 144f1e2c6f.
2018-09-19 12:01:52 -07:00
Miss Islington (bot) 73c0006e71
bpo-33649: Add a high-level section about Futures; few quick fixes (GH-9403)
Co-authored-by: Elvis Pranskevichus <elvis@magic.io>
(cherry picked from commit 471503954a)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-18 15:09:51 -07:00
Miss Islington (bot) 45452b738b
bpo-33649: Fix markup; add another note that asyncio.run is 3.7+ (GH-9389)
(cherry picked from commit b042cf10c6)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-18 00:00:58 -07:00
Miss Islington (bot) ee2ff1a335 Fix syntax error on Asyncio example in doc (GH-9387) (GH-9388)
The `gather` method requires to close the parenthesis, but it is being closed twice.
(cherry picked from commit 9c53fa6ad9)

Co-authored-by: Miguel Ángel García <magmax@users.noreply.github.com>
2018-09-18 02:27:27 -04:00
Miss Islington (bot) 9a89fd6884 Change "set_after" reference to `say_after`. (GH-9384) (GH-9386)
(cherry picked from commit 7bfbda46f4)

Co-authored-by: Danny Hermes <daniel.j.hermes@gmail.com>
2018-09-18 02:27:07 -04:00
Miss Islington (bot) 1f4ea58067
bpo-33649: Note that asyncio.run() calls shutdown_asyncgens() (GH-9380)
(cherry picked from commit ac94e38d07)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-17 21:12:05 -07:00
Victor Stinner 144f1e2c6f
[3.7] bpo-34589: Add -X coerce_c_locale option; C locale coercion off by default (GH-9379)
* bpo-34589: Make _PyCoreConfig.coerce_c_locale private (GH-9371)

_PyCoreConfig:

* Rename coerce_c_locale to _coerce_c_locale
* Rename coerce_c_locale_warn to _coerce_c_locale_warn

These fields are now private (name prefixed by "_").

(cherry picked from commit 188ebfa475)

* bpo-34589: C locale coercion off by default (GH-9073)

Py_Initialize() and Py_Main() cannot enable the C locale coercion
(PEP 538) anymore: it is always disabled. It can now only be enabled
by the Python program ("python3).

test_embed: get_filesystem_encoding() doesn't have to set PYTHONUTF8
nor PYTHONCOERCECLOCALE, these variables are already set in the
parent.

(cherry picked from commit 7a0791b699)

* bpo-34589: Add -X coerce_c_locale command line option (GH-9378)

Add a new -X coerce_c_locale command line option to control C locale
coercion (PEP 538).

(cherry picked from commit dbdee0073c)
2018-09-17 18:01:39 -07:00
Yury Selivanov 512d710109
bpo-33649: Backport asyncio docs from 'master' to 3.7 (GH-9377) 2018-09-17 19:35:30 -04:00
Miss Islington (bot) c63d81b3fe
bpo-34717: Stop numbering stdlib titles/sections in the docs (GH-9370)
(cherry picked from commit c62ab2862d)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-17 15:42:09 -07:00
Miss Islington (bot) f8e34eee74
bpo-33216: Improve the documentation for CALL_FUNCTION_* (GH-8338) (GH-8784)
(cherry picked from commit 5e99b56d6b)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-09-17 06:09:32 -07:00
Miss Islington (bot) c83c375ed9 bpo-32933: Implement __iter__ method on mock_open() (GH-5974)
(cherry picked from commit 2087023fde)

Co-authored-by: Tony Flury <anthony.flury@btinternet.com>
2018-09-15 00:30:04 +03:00
Miss Islington (bot) b2ecb8b486 Fix "Python" casing in a few places (GH-9001) (GH-9313)
(cherry picked from commit 271818fe27)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-09-14 12:15:10 -07:00
Miss Islington (bot) ca2fa2841f
closes bpo-28955: Clarified comparisons between NaN and number in reference documentation (GH-5982)
Co-authored-by: Benjamin Peterson <benjamin@python.org>
(cherry picked from commit ad8a000420)

Co-authored-by: Tony Flury <anthony.flury@btinternet.com>
2018-09-14 11:05:38 -07:00
Miss Islington (bot) a8f189f457 Note that distinct argument patterns can be cached separately (GH-9298) (GH-9299)
(cherry picked from commit 902bcd9a1e)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2018-09-14 01:13:17 -07:00
Miss Islington (bot) 305056494d
bpo-34247: add porting note to 3.7 What's New (GH-9223)
(cherry picked from commit 66755cbb1e)

Co-authored-by: Ned Deily <nad@python.org>
2018-09-13 12:14:46 -07:00
Miss Islington (bot) b608fcd444
closes bpo-34004: Skip lock interruption tests on musl. (GH-9224)
Returning EINTR from pthread semaphore or lock acquisition is an optional POSIX
feature. musl does not provide this feature, so some threadsignal tests fail
when Python is built against it.

There's no good way to test for musl, so we skip if we're on Linux and not using
glibc pthreads.

Also, hedge in the threading documentation about when we can provide interrupts
from lock acquisition.
(cherry picked from commit 5b10d5111d)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2018-09-12 14:10:56 -07:00
Benjamin Peterson cadb66e173
[3.7] closes bpo-25041: Document AF_PACKET socket address format. (GH-9207)
(cherry picked from commit 731ff68eee)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-09-11 18:46:36 -07:00
Miss Islington (bot) e2b40f4ce9
bpo-34365: Update date object documentation (GH-8814)
Python 3.x does not fall back to comparing object addresses when comparing two `dt` objects.

<!-- issue-number: [bpo-34365](https://www.bugs.python.org/issue34365) -->
https://bugs.python.org/issue34365
<!-- /issue-number -->
(cherry picked from commit 9c223794c7)

Co-authored-by: Danish Prakash <grafitykoncept@gmail.com>
2018-09-11 14:24:53 -07:00
Miss Islington (bot) e02ca4270e
bpo-34613: document the correct value of limit argument of asyncio.StreamReader (GH-9121)
The default value of asyncio.StreamReader *limit* is `_DEFAULT_LIMIT` instead of `None`.

<!-- issue-number: [bpo-34613](https://www.bugs.python.org/issue34613) -->
https://bugs.python.org/issue34613
<!-- /issue-number -->
(cherry picked from commit b4ec36200a)

Co-authored-by: Bram <cortex@worlddomination.be>
2018-09-11 11:59:29 -07:00
Miss Islington (bot) 3e648f8371
bpo-28617 Fixed docs inaccuracies about the types that support membership tests (GH-9086)
<!-- issue-number: [bpo-28617](https://www.bugs.python.org/issue28617) -->
https://bugs.python.org/issue28617
<!-- /issue-number -->
(cherry picked from commit 08bcf647d8)

Co-authored-by: wim glenn <wim.glenn@gmail.com>
2018-09-11 11:13:33 -07:00
Miss Islington (bot) c9ece5f4a9
closes bpo-33883: Mention type checkers in the FAQ. (GH-7760)
(cherry picked from commit a378254186)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-09-10 22:27:00 -07:00
Miss Islington (bot) 2110f78d92
bpo-33032: Mention the implicit cache in struct.Struct() docs (GH-7700)
Mention the implicit cache in struct.Struct() docs.

Consistent with the re.compile documentation note.
(cherry picked from commit 3666b3c1f6)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2018-09-10 21:50:41 -07:00
Miss Islington (bot) 6df2005b39 Fix missing line from example shell session (GH-9143) (GH-9155)
(cherry picked from commit 2064bb6d57)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2018-09-10 19:13:02 -07:00
Miss Islington (bot) 037582eb7f
bpo-33460: remove ellipsis that look like continuation prompts (GH-7851)
Remove ellipsis that look like continuation prompts,
has a side benefit of putting rest of error message in proper text color.
(cherry picked from commit f019579828)

Co-authored-by: Lew Kurtz <37632626+lew18@users.noreply.github.com>
2018-09-10 18:49:39 -07:00
Miss Islington (bot) f3d00ae3be
switch descriptor howto to return value annotation (GH-7796)
(cherry picked from commit 28ea4c2847)

Co-authored-by: NotAFile <notafile@gmail.com>
2018-09-10 17:44:58 -07:00
Miss Islington (bot) 011141f312
closes bpo-34525: Fix smtplib's authobject() documentation (GH-8965)
(cherry picked from commit 78deb7f332)

Co-authored-by: Sebastian Rittau <srittau@rittau.org>
2018-09-10 11:13:13 -07:00
Miss Islington (bot) 9c9ac9e697
Revert "Fix misindented yaml in logging how to example (GH-8604)" (GH-9081)
This reverts commit 10b59f1b01.
(cherry picked from commit 290a60bd8a)

Co-authored-by: Rémy HUBSCHER <hubscher.remy@gmail.com>
2018-09-10 02:13:18 -07:00
Miss Islington (bot) 9835696ec4
bpo-34246: Use no mutable default args in smtplib (GH-8554)
Some methods of the SMTP class use mutable default arguments. Specially
`send_message` is affected as it mutates one of the args by appending items
to it, which has side effects on further calls.
(cherry picked from commit d5fbe9b1a3)

Co-authored-by: Pablo Aguiar <scorphus@gmail.com>
2018-09-07 15:29:27 -07:00
Miss Islington (bot) 854b740910 Doc: Missing 'f' in an f-string. (GH-9074) (GH-9095)
(cherry picked from commit 25fa141487)

Co-authored-by: Julien Palard <julien@palard.fr>
2018-09-07 11:59:00 +02:00
Miss Islington (bot) f4c865eda8
Fix struct sequence glossary entry grammar (GH-9030)
... by removing a superfluous "either".

Reported by Никита Люшненко on docs@.
(cherry picked from commit 98b976a2f8)

Co-authored-by: Zachary Ware <zachary.ware@gmail.com>
2018-09-01 22:13:34 -04:00
Miss Islington (bot) fa3fd4cb18
bpo-34434: Update doc for bool(), float() and int() arguments (GH-8834)
(cherry picked from commit 3fe89dac42)

Co-authored-by: Louis Sautier <sautier.louis@gmail.com>
2018-08-27 06:58:56 -04:00
Miss Islington (bot) 42a1ca65d0
closes bpo-34502: Remove a note about utf8_mode from sys.exit() docs. (GH-8928)
(cherry picked from commit 44838be9f7)

Co-authored-by: Alexey Izbyshev <izbyshev@ispras.ru>
2018-08-25 14:36:18 -04:00
Miss Islington (bot) 6dc8f05437
Fix markup in stdtypes documentation (GH-8905)
(cherry picked from commit 2e5d2ea208)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-08-25 10:22:00 -04:00
Miss Islington (bot) 1f9621cb9b
Fixed typo with asynccontextmanager code example (GH-8845)
`yield conn`, instead of just `yield`.
(cherry picked from commit 416cbce22d)

Co-authored-by: Alexander Vasin <hi@alvass.in>
2018-08-24 22:51:10 -04:00
Miss Islington (bot) 7b0ed43af5 bpo-33550: Warn not to set SIGPIPE to SIG_DFL (GH-6773)
(cherry picked from commit a2510732da)

Co-authored-by: Alfred Perlstein <alfred@freebsd.org>
2018-08-24 19:28:58 -07:00
Miss Islington (bot) a8c749df59 Fix typo in the dataclasses's doc (GH-8896) (GH-8897)
(cherry picked from commit 075b3c3259)

Co-authored-by: Daniel Dương <dduong42@users.noreply.github.com>
2018-08-24 05:37:19 -04:00
Miss Islington (bot) 1d3d688b98
Fix doc for `add_subparsers` arguments (GH-8884)
There was a missing comma.
(cherry picked from commit cc18258daf)

Co-authored-by: Anthony Sottile <asottile@umich.edu>
2018-08-23 23:22:17 -04:00
Miss Islington (bot) 609c033f43
Fix typo in asyncio.BoundedSemaphore docs (GH-8882)
semapthores -> semaphores
(cherry picked from commit b8a181f4ae)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2018-08-23 22:03:23 -04:00
Miss Islington (bot) 1f7d0470c2
Make it more clear that setUpClass runs before each class, not "class run" (GH-8844)
(cherry picked from commit c33bb5d401)

Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
2018-08-23 11:02:46 -04:00
Miss Islington (bot) 0e1e8dbb0b
bpo-22057: Clarify eval() documentation (GH-8812)
If a globals dictionary without a '__builtins__' key is passed to
eval(), a '__builtins__' key will be inserted to the dictionary:

    >>> eval("print('__builtins__' in globals())", {})
    True

(As a result of this behavior, we can use the builtins
print() and globals() even if we passed a dictionary without a
'__builtins__' key to eval().)
(cherry picked from commit 225b055480)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
2018-08-19 06:29:50 -04:00
Miss Islington (bot) 0fd6f832a9 bpo-34432: doc Mention complex and decimal.Decimal on str.format note about locales (GH-8808) (GH-8809)
(cherry picked from commit 93b5655c04)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-08-18 14:16:36 -04:00
Miss Islington (bot) 05d89ef785
bpo-34418: Fix HTTPErrorProcessor documentation (GH-8793)
The http_response() and https_response() methods of the HTTPErrorProcessor
class have two required parameters, 'request' and 'response'.
(cherry picked from commit c53aaec793)

Co-authored-by: Sebastian Rittau <srittau@rittau.org>
2018-08-17 06:02:08 -04:00
Miss Islington (bot) 6c14060977
smtplib documentation fixes (GH-8708)
* SMTP.startssl: Fix doc on keyfile and certfile use

* SMTP.startssl: Add missing keyfile and certfile deprecation notice

* SMTP: Doc grammar fixes
(cherry picked from commit da12063f2f)

Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
2018-08-12 21:06:22 -07:00
Miss Islington (bot) 393151e241
Fix misindented yaml in logging how to example (GH-8604)
(cherry picked from commit 10b59f1b01)

Co-authored-by: Rémy HUBSCHER <hubscher.remy@gmail.com>
2018-08-12 17:04:44 -07:00
Miss Islington (bot) 7e0153e166
Fix the versionadded indentation in exec_module doc (GH-8719)
(cherry picked from commit 65b5ef02ec)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-08-12 00:01:21 -07:00
Miss Islington (bot) 6b14508522
bpo-34379: Doc: Move note for json.dump (GH-8730)
(cherry picked from commit 9e84084851)

Co-authored-by: Evan Allrich <eallrich@gmail.com>
2018-08-11 01:02:03 -07:00
Miss Islington (bot) 56410810d3
Doc: add missing capture_output arg to subprocess.run() signature (GH-8374)
(cherry picked from commit 22d131a7f9)

Co-authored-by: Andriy Maletsky <9919211+and800@users.noreply.github.com>
2018-08-09 15:03:52 -07:00
Miss Islington (bot) 426135b674
Improve grammar of asynchronous iterator glossary entry (GH-8657)
(cherry picked from commit cf2c5e8e28)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-08-09 09:08:49 -07:00
Miss Islington (bot) fe8f90aa3c
bpo-34324: Doc README wrong directory name for venv (GH-8650)
In the documentation, the `env` directory is specified when we execute
the `make venv` command. But in the code, `make venv` will create the
virtualenv inside the `venv` directory (defined by `VENVDIR`)
(cherry picked from commit 599bfa18f8)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-08-09 08:10:27 -07:00
Miss Islington (bot) 292030354a
Make code examples in Functional Programming HOWTO to be PEP 8 compliant. (GH-8646)
(cherry picked from commit db8707c8ab)

Co-authored-by: Sergey Fedoseev <fedoseev.sergey@gmail.com>
2018-08-07 14:56:25 -07:00
Miss Islington (bot) fac49762c5
bpo-34335: Use async/await syntax in documentation examples (GH-8674)
(cherry picked from commit d2ac400267)

Co-authored-by: Mikhail Terekhov <termim@gmail.com>
2018-08-07 13:33:31 -07:00
Miss Islington (bot) b481aeeff7
Fix HTML formatting in datamodel.rst (GH-8693)
(cherry picked from commit 3c1b590472)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
2018-08-06 14:12:37 -07:00
Miss Islington (bot) 1c6df83e93
bpo-34319: Clarify file handler closure in pathlib.read_text (GH-8645)
Patch by Terry Jan Reedy.
(cherry picked from commit 5b2657fb8c)

Co-authored-by: Xtreak <tirkarthi@users.noreply.github.com>
2018-08-06 12:59:43 -07:00
Miss Islington (bot) e39fb207f2
bpo-34273: Change 'Fixed point' to 'Fixed-point notation'. (GH-8673)
* bpo-34273: Change 'Fixed point' to 'Fixed-point notation'.
The change in the mini language floating point and decimal table
is consistent with 'Exponential notation' and clarifies that we
are referring to the output notation, not an object type.

* Update string.rst

* Update string.rst

* Update string.rst

* Update string.rst
(cherry picked from commit 28c7f8c8ce)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-08-06 05:47:36 -07:00
Miss Islington (bot) e610c4f998
bpo-34336: Don't promote possibility to leave out typing.Optional (GH-8677)
(cherry picked from commit 336c945858)

Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
2018-08-05 10:36:04 -07:00
Miss Islington (bot) 2a2a3f56f5 Fix reST markup in unittest documentation (GH-8665)
(cherry picked from commit 2e5566d9e7)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
2018-08-04 01:13:52 +03:00
Miss Islington (bot) 39fcd99498 bpo-34329: Doc'd how to remove suffix of pathlib.Path() (GH-8655)
(cherry picked from commit 46dc4e34ed)

Co-authored-by: Stefan Otte <stefan.otte@gmail.com>
2018-08-04 00:45:46 +03:00
Miss Islington (bot) b4d71c9149
Improve the grammar in `range` documentation. (GH-8628)
Remove unnecessary "that" in the sentence.
(cherry picked from commit b6efc2cf97)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-08-02 23:16:07 -07:00
Miss Islington (bot) 34f59a7a78
bpo-34317: Fix a dead url to Windows documentation (GH-8622)
(cherry picked from commit 46ebe61c7f)

Co-authored-by: HiyashiChuka <41299525+hiyashichuka@users.noreply.github.com>
2018-08-02 20:29:39 -07:00
Miss Islington (bot) 66ff9d270c
Update list.remove(x) documentation (GH-8636)
Rephrase it to "It raises a `ValueError`"
(cherry picked from commit bcd1d971b6)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2018-08-02 20:03:19 -07:00
Miss Islington (bot) 0f9df886d6 bpo-27910: Update documentation of traceback module (GH-6116)
In the documentation for the traceback module, the definitions of functions
extract_tb(), format_list() and classmethod StackSummary.from_list()
mention the old style 4-tuples that these functions used to return or accept.

Since Python 3.5, however, they return or accept a FrameSummary object
instead of a 4-tuple, or a StackSummary object instead of a list of 4-tuples.

Co-authored-by: torsava <torsava@redhat.com>
Co-Authored-By: Berker Peksag <berker.peksag@gmail.com>

(cherry picked from commit f394ee5eaf)
2018-08-02 19:51:48 +03:00
Serhiy Storchaka 47957dab94
[3.7] bpo-33729: Fix issues with arguments parsing in hashlib. (GH-8346) (GH-8581)
* help(hashlib) didn't work because of incorrect module name in blake2b and
  blake2s classes.
* Constructors blake2*(), sha3_*(), shake_*() and keccak_*() incorrectly
  accepted keyword argument "string" for binary data, but documented as
  accepting the "data" keyword argument. Now this parameter is positional-only.
* Keyword-only parameters in blake2b() and blake2s() were not documented as
  keyword-only.
* Default value for some parameters of blake2b() and blake2s() was None,
  which is not acceptable value.
* The length argument for shake_*.digest() was wrapped out to 32 bits.
* The argument for shake_128.digest() and shake_128.hexdigest() was not
  positional-only as intended.
* TypeError messages for incorrect arguments in all constructors sha3_*(),
  shake_*() and keccak_*() incorrectly referred to sha3_224.

Also made the following enhancements:

* More accurately specified input and result types for strings, bytes and
  bytes-like objects.
* Unified positional parameter names for update() and constructors.
* Improved formatting.
(cherry picked from commit f1d36d8efa)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-07-31 10:22:44 +03:00
Miss Islington (bot) a621f40640
bpo-27671: Update FAQ about why len is function (GH-8432)
(cherry picked from commit c48e26dcad)

Co-authored-by: INADA Naoki <methane@users.noreply.github.com>
2018-07-30 22:54:25 -07:00
Miss Islington (bot) 399b47fdf6
Use 'for example' instead of 'in other words' in compound statement doc (GH-8401)
(cherry picked from commit 6921ef7bef)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-30 12:30:31 -07:00
Miss Islington (bot) a060518204
Fix typos & formatting in Using Python on Windows doc (GH-8559)
(cherry picked from commit 8e7e8bd898)

Co-authored-by: Segev Finer <segev208@gmail.com>
2018-07-30 11:09:22 -07:00
Steve Dower 3dc8cdf56d
bpo-8145: Improve isolation_level documentation (GH-8499)
Initial patch by R. David Murray.
2018-07-29 12:06:35 +01:00
Miss Islington (bot) 78c54de575 bpo-33666: Add what's new entry for os.errno removal (GH-8497) (GH-8526)
(cherry picked from commit 1d2dafa249)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: INADA Naoki <methane@users.noreply.github.com>
2018-07-29 10:39:48 +01:00
Miss Islington (bot) 8764a6ffda
bpo-29710: Clarify documentation for Bitwise binary operation (GH-1691)
Mathematically, bitwise operations on integers behave as if there were an
infinite number of sign bits. Pragmatically, that gives the same answer as
using one extra sign bit for the bitwise logical operations.
(cherry picked from commit b4bc5cab82)

Co-authored-by: Sanyam Khurana <8039608+CuriousLearner@users.noreply.github.com>
2018-07-28 09:52:14 -07:00
Steve Dower 83b449d754
bpo-24356: Specify which Python binary will be used with venv (GH-6589) 2018-07-28 17:48:29 +01:00
Miss Islington (bot) 2335544562
bpo-33921: Clarify how to bind to all interfaces using socket (GH-7877)
Clarify how to bind to all interfaces using socket
(cherry picked from commit 95dfb9c3ae)

Co-authored-by: johnthagen <johnthagen@users.noreply.github.com>
2018-07-28 05:27:15 -07:00
Miss Islington (bot) c6801b48a1
bpo-5978: Document that profiling needs cmd/function to return (GH-7938)
<!-- issue-number: bpo-5978 -->
https://bugs.python.org/issue5978
<!-- /issue-number -->
(cherry picked from commit 937fb55d35)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-28 05:23:42 -07:00
Miss Islington (bot) 21ed29ac29
bpo-12743: Delete comment from marshal.rst (GH-8457)
Also, update the list of exceptions that may raised by PyMarshal_*
functions. We usually don't document exceptions raised by a
function, but in this case most of them were already documented
in C API and standard library documentation.
(cherry picked from commit defcffdf86)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
2018-07-26 21:40:37 -07:00
Miss Islington (bot) ec02c58f5a bpo-28677: Improve phrasing of when instance attribute is referenced (GH-6208)
(cherry picked from commit c0f0a7669c)

Co-authored-by: Aaron Ang <aaronang@users.noreply.github.com>
2018-07-25 20:52:18 +03:00
Miss Islington (bot) 6f7fd963a0 Fix site module documentation. (GH-8441)
The script will exit with the number 0 (zero), instead of the letter O.
(cherry picked from commit 95d34c2a37)

Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
2018-07-24 10:30:33 -07:00
Miss Islington (bot) 4e166ffd29 bpo-33468: Add try-finally contextlib.contextmanager example (GH-7816) (GH-8425)
(cherry picked from commit bde782bb59)

Co-authored-by: Matthias Bussonnier <bussonniermatthias@gmail.com>
2018-07-24 00:38:18 +03:00
Miss Islington (bot) 05a72f15f7 bpo-21446: Update reload fixer to use importlib (GH-8391)
(cherry picked from commit 7a3056fa7d)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
2018-07-23 11:11:22 +03:00
Miss Islington (bot) 7cf7541aa4 Fix versionchanged indentation in popitem documentation (GH-8387)
(cherry picked from commit cb9c299a55)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-21 16:04:54 -07:00
Miss Islington (bot) 49abd307d2 bpo-34161: Remove extra parentheses in output formatting tutorial (GH-8350)
The parentheses were incorrect.
(cherry picked from commit cb5f3fdb9d)

Co-authored-by: Aaqa Ishtyaq <aaqaishtyaq@gmail.com>
2018-07-20 13:38:06 -07:00