Commit Graph

21969 Commits

Author SHA1 Message Date
Miss Islington (bot) bd9a70c2c1 bpo-28556: Remove another mention of metaclass of Generic in typing docs (GH-16743)
Metaclass was removed in Python 3.7 (there is already a `versionchanged` item about this).

https://bugs.python.org/issue28556
(cherry picked from commit 8144095707)

Co-authored-by: Ivan Levkivskyi <levkivskyi@gmail.com>
2019-10-14 17:29:02 -04:00
Miss Islington (bot) c16897cd9e Fix typo: equivalent code of `async with cond` (GH-11681) (GH-16720) 2019-10-14 17:22:18 -04:00
Miss Islington (bot) 49e650b248 bpo-32996: Documentation fix-up. (GH-16646)
PR GH-4906 changed the typing.Generic class hierarchy, leaving an
outdated comment in the library reference. User-defined Generic ABCs now
must get a abc.ABCMeta metaclass from something other than typing.Generic
inheritance.
(cherry picked from commit d47f0dd2e8)

Co-authored-by: M. Eric Irrgang <mei2n@virginia.edu>
2019-10-14 17:18:08 -04:00
Miss Islington (bot) 42b16b2a86 bpo-36953: Delay removal of ABCs from collections. (GH-13409)
Bump the removal to 3.9, indicate collections.abc available since 3.3,
replace version-changed directive to deprecated-removed.

https://bugs.python.org/issue36953
(cherry picked from commit eea47e0939)

Co-authored-by: Matthias Bussonnier <mbussonnier@ucmerced.edu>
2019-10-14 17:04:26 -04:00
Ricardo Bánffy ae41f629e1 [3.7] bpo-38294: Add list of no-longer-escaped chars to re.escape documentation. (GH-16442) (GH-16647)
Prior to 3.7, re.escape escaped many characters that don't have
special meaning in Python, but that use to require escaping in other
tools and languages. This commit aims to make it clear which characters
were, but are no longer escaped.
(cherry picked from commit 15ae75d660)
2019-10-14 17:00:49 -04:00
Miss Islington (bot) e9c65b4ae7 bpo-38391: Fixing a typo for Py_DECREF (GH-16616)
(cherry picked from commit 038503e08a)

Co-authored-by: Krishna Oza <krishoza15sep@gmail.com>
2019-10-14 16:54:26 -04:00
Miss Islington (bot) f168c17b07 bpo-26510: Add versionchanged for required arg of add_subparsers (GH-16588)
The `required` argument to `argparse.add_subparsers` was added in GH-3027. This PR specifies the earliest version of Python where it is available.

https://bugs.python.org/issue26510

Automerge-Triggered-By: @merwok
(cherry picked from commit 9e71917e02)

Co-authored-by: Adam J. Stewart <ajstewart426@gmail.com>
2019-10-14 16:53:27 -04:00
Miss Islington (bot) 6eb5545832 bpo-38235: Correct some arguments names in logging documentation (GH-16571) (GH-16577)
(cherry picked from commit 3142c667b5)

Co-authored-by: Ashley Whetter <AWhetter@users.noreply.github.com>
2019-10-14 16:50:11 -04:00
Miss Islington (bot) 874dae48fe
Correct typos in the codecs module documentation (GH-15135)
(cherry picked from commit 891e9e3b44)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2019-10-01 13:56:40 -07:00
Miss Islington (bot) 2eb1dac46e Fix and improve `asyncio.run()` docs (GH-16403) (GH-16505)
(cherry picked from commit e407013089)

Co-authored-by: Kyle Stanley <aeros167@gmail.com>
2019-09-30 18:47:13 -07:00
Miss Islington (bot) 5017a645b0 bpo-38130: Fix error in explaining when an exception is re-raised (GH-16016) (GH-16416)
Co-Authored-By: Ashwin Ramaswami <aramaswamis@gmail.com>
(cherry picked from commit 1ad7be2f16)

Co-authored-by: Mohammad Dehghan <md.unicorn@gmail.com>
2019-09-26 11:15:21 +02:00
Miss Islington (bot) 80bde15736 Doc: Use the `with` statement in the first example of the ftplib doc. (GH-16271) (GH-16413)
(cherry picked from commit 5d326abf2c)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2019-09-26 09:12:26 +02:00
Miss Islington (bot) 3b5e924114 bpo-38255: super() can search attributes as well as methods (GH-16368) (GH-16392)
Improvement suggested by Géry Ogam.
(cherry picked from commit 15ccc4fac0)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-09-25 08:24:24 -07:00
Miss Islington (bot) d3666945d7
bpo-38260: Add Docs on asyncio.run (GH-16337)
Add docs about return and raise exception on asyncio.run

https://bugs.python.org/issue38260

Automerge-Triggered-By: @asvetlov
(cherry picked from commit 17deb16883)

Co-authored-by: Emmanuel Arias <emmanuelarias30@gmail.com>
2019-09-25 02:13:00 -07:00
Miss Islington (bot) fd4f28d894
bpo-37937: Mention frame.f_trace in sys.settrace docs (GH-15439)
Mention frame.f_trace in sys.settrace docs, as well as the fact you still
need to call `sys.settrace` to enable the tracing machinery before setting
`frame.f_trace` will have any effect.
(cherry picked from commit 9c2682efc6)

Co-authored-by: Ram Rachum <ram@rachum.com>
2019-09-20 08:25:12 -07:00
Miss Islington (bot) 2552e27b75
bpo-37353: Updated parser note about source code compatibility(GH-14277)
(cherry picked from commit 062cfe3b11)

Co-authored-by: Prateek Nayak <45075669+Kriyszig@users.noreply.github.com>
2019-09-20 07:02:00 -07:00
Miss Islington (bot) 50ecedc103
Doc: Clarify dict equality irrespective of ordering. (GH-16266)
(cherry picked from commit 3171d67a6a)

Co-authored-by: toonarmycaptain <toonarmycaptain@hotmail.com>
2019-09-18 22:57:32 -07:00
Miss Islington (bot) 20d3bce3ef [3.7] bpo-38218: Doc: Corrected syntax for return annotation (GH-16265) (GH-16275)
Signed-off-by: Jason Plurad <pluradj@us.ibm.com>
(cherry picked from commit 9ab6038fe8)

Co-authored-by: Jason Plurad <pluradj@us.ibm.com>
2019-09-19 07:37:38 +02:00
Miss Islington (bot) 1a3a48ddaf
bpo-38203: faulthandler.dump_traceback_later() is always available (GH-16260)
dump_traceback_later() and cancel_dump_traceback_later() functions of
the faulthandler module are always available since Python 3.7.
(cherry picked from commit 064e1e3841)

Co-authored-by: Victor Stinner <vstinner@redhat.com>
2019-09-18 05:43:17 -07:00
Miss Islington (bot) 8b907a8875 bpo-37904: Edition on python tutorial - section 4 (GH-16169) (GH-16235)
A little change on first paragraph of python tutorial to be more clearly

https://bugs.python.org/issue37904

Automerge-Triggered-By: @ericvsmith
(cherry picked from commit b57481318e)

Co-authored-by: Diego Alberto Barriga Martínez <diegobarriga@protonmail.com>
2019-09-18 06:36:35 -04:00
Miss Islington (bot) 6422392f34
Doc: Fix grammar/spelling in ssl.VERIFY_CRL_CHECK_LEAF docs (GH-16221)
(cherry picked from commit 219fb9d65e)

Co-authored-by: Jörn Heissler <joernheissler@users.noreply.github.com>
2019-09-17 03:49:08 -07:00
Miss Islington (bot) facbd316b4
bpo-38192: Fix remaining passing of "loop" in the protocol examples (GH-16202)
See https://bugs.python.org/issue38192 .

https://bugs.python.org/issue38192
(cherry picked from commit 5d359cc62e)

Co-authored-by: Hrvoje Nikšić <hniksic@gmail.com>
2019-09-17 00:22:48 -07:00
Miss Islington (bot) 89f132a328 Doc: Add list(dict) in stdtypes library (GH-16209) (GH-16211)
(cherry picked from commit 63dedef48b)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2019-09-17 07:04:19 +02:00
Miss Islington (bot) 733193d050
bpo-28556: Update the opening note in typing docs (GH-16204)
This PR replaces the old note mentioning that `typing` is a provisional module with a new one mentioning types are not enforced at runtime. I am not sure if there was any official announcement about making `typing` non-provisional, but _de-facto_ no new features were added during Python 3.7, and no backwards incompatible changes were made except for few small things that were considered bugs.
(cherry picked from commit 81528ba2e8)

Co-authored-by: Ivan Levkivskyi <levkivskyi@gmail.com>
2019-09-16 15:10:11 -07:00
Miss Islington (bot) ad4ce9edf3 Doc: Add link of GNU Readline library to interpreter tutorial (GH-16152) (GH-16188)
(cherry picked from commit f18242be16)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2019-09-16 18:29:50 +02:00
Julien Palard 210dc3bb37
[3.7] bpo-33095: Add reference to isolated mode in -m and script option (GH-7764) (GH-16181)
Attempt to make isolated mode easier to discover via additional inline documentation.

Co-Authored-By: Julien Palard <julien@palard.fr>.
(cherry picked from commit bdd6945d4d)

Co-authored-by: Xtreak <tir.karthi@gmail.com>
2019-09-16 14:30:33 +02:00
Miss Islington (bot) 701c4886bb
bpo-38178: Don't explicitly pass "loop" to EchoClientProtocol. (GH-16159)
https://bugs.python.org/issue38178
(cherry picked from commit c717c73fa3)

Co-authored-by: Hrvoje Nikšić <hniksic@gmail.com>
2019-09-15 10:12:13 -07:00
Miss Islington (bot) b9f932f9e2
bpo-37635: Update arg name for seek() in IO tutorial (GH-16147)
Typically, the second positional argument for ``seek()`` is *whence*. That is the POSIX standard name (http://man7.org/linux/man-pages/man3/lseek.3p.html) and the name listed in the documentation for ``io`` module (https://docs.python.org/3/library/io.htmlGH-io.IOBase.seek).

The tutorial for IO is the only location where the second positional argument for ``seek()`` is referred to as *from_what*. I suspect this was created at an early point in Python's history, and was never updated (as this section predates the GitHub repository):

```
$ git grep "from_what"
Doc/tutorial/inputoutput.rst:To change the file object's position, use ``f.seek(offset, from_what)``.  The position is computed
Doc/tutorial/inputoutput.rst:the *from_what* argument.  A *from_what* value of 0 measures from the beginning
Doc/tutorial/inputoutput.rst:the reference point.  *from_what* can be omitted and defaults to 0, using the
```

For consistency, I am suggesting that the tutorial be updated to use the same argument name as the IO documentation and POSIX standard for ``seek()``, particularly since this is the only location where *from_what* is being used.

Note: In the POSIX standard, *whence* is technically the third positional argument, but the first argument *fildes* (file descriptor) is implicit in Python.

https://bugs.python.org/issue37635
(cherry picked from commit ff603f6c3d)

Co-authored-by: Kyle Stanley <aeros167@gmail.com>
2019-09-14 13:47:39 -07:00
Miss Islington (bot) 4fac58165b
Doc: Fix link to window.getch in curses documentation (GH-16132)
(cherry picked from commit a26ace19bd)

Co-authored-by: Anthony Sottile <asottile@umich.edu>
2019-09-13 23:23:20 -07:00
Miss Islington (bot) 77878cadc5
bpo-32790: Add info about alt format using GH- for 'g' in chart (GH-6624)
(cherry picked from commit d44542f9a2)

Co-authored-by: bchhabra2490 <bchhabra2490@gmail.com>
2019-09-13 10:26:51 -07:00
Miss Islington (bot) 6e0c066f89
Emphasize the need to always call PySequence_Fast. (GH-11140)
(cherry picked from commit 57b7dbc46e)

Co-authored-by: Matti Picus <matti.picus@gmail.com>
2019-09-12 09:25:55 -07:00
Miss Islington (bot) e3c25fc902 bpo-38096: Complete the "structseq" and "named tuple" cleanup (GH-16010) (GH-16063)
(cherry picked from commit 4210ad5ebd)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-09-12 08:20:07 -07:00
Miss Islington (bot) c8d1338441
bpo-26868: Fix example usage of PyModule_AddObject. (GH-15725)
* Add a note to the PyModule_AddObject docs.

* Correct example usages of PyModule_AddObject.

* Whitespace.

* Clean up wording.

* 📜🤖 Added by blurb_it.

* First code review.

* Add < 0 in the tests with PyModule_AddObject
(cherry picked from commit 224b8aaa7e)

Co-authored-by: Brandt Bucher <brandtbucher@gmail.com>
2019-09-12 05:29:09 -07:00
Miss Islington (bot) 01b47c94ca
bpo-35325: Doc: imp.find_module() return value documentation discrepancy (GH-11040)
(cherry picked from commit 967b84c913)

Co-authored-by: Windson yang <wiwindson@outlook.com>
2019-09-12 05:24:56 -07:00
Miss Islington (bot) 07b4148f39 bpo-32008: Prefer client or TLSv1_2 in examples (GH-5797) (GH-16026)
Prefer client or TLSv1_2 in examples

Signed-off-by: Christian Heimes <christian@python.org>
(cherry picked from commit 894d0f7d55)

Co-authored-by: Christian Heimes <christian@python.org>
2019-09-12 12:20:41 +01:00
Miss Islington (bot) ff2a5c0204 Doc: Update pickle.rst (GH-14128) (GH-16015)
* Edits for readability and grammar
(cherry picked from commit 362f5350eb)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2019-09-12 09:19:33 +01:00
Paul Ganssle b7a310d865 bpo-38096: Clean up the "struct sequence" / "named tuple" docs (GH-15895) (GH-15962) 2019-09-11 19:50:51 -07:00
Miss Islington (bot) bf0c76cdf6 Doc: Fix missing negation. (GH-14640) (GH-15985)
Reported by Hug Capella on docs@.

Automerge-Triggered-By: @matrixise
(cherry picked from commit 1fae844451)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-09-11 19:53:56 +02:00
Miss Islington (bot) e4be7c8ba1 Improve clarity of try-return-finally-return (GH-15677) (GH-15982)
Clarify execution in try-return-finally-return case.
(cherry picked from commit 0cc27417f2)

Co-authored-by: toonarmycaptain <toonarmycaptain@hotmail.com>
2019-09-11 19:42:09 +02:00
Miss Islington (bot) c62da14776 bpo-37698: Update doc of PyBuffer_ToContiguous (GH-14992) (GH-15998)
https://bugs.python.org/issue37698
(cherry picked from commit 15f5a7527b)

Co-authored-by: Hai Shi <shihai1992@gmail.com>
2019-09-11 19:34:19 +02:00
Miss Islington (bot) 9b46586124
Doc: recursive glob ** follows symlinks to directories (GH-12918)
(cherry picked from commit e24594bfe7)

Co-authored-by: Marc <Marc.Herbert+github@gmail.com>
2019-09-11 10:28:16 -07:00
Miss Islington (bot) c112faff15 bpo-37750: Add doc of PyBuffer_FromContiguous (GH-15988) (GH-15991)
https://bugs.python.org/issue37750

Automerge-Triggered-By: @matrixise
(cherry picked from commit 5a56ce4a0e)

Co-authored-by: Hai Shi <shihai1992@gmail.com>
2019-09-11 19:10:23 +02:00
Miss Islington (bot) 195dc142f8 bpo-33187: Document ElementInclude (XInclude) support in ElementTree (GH-8861) (GH-15972)
(cherry picked from commit 97b817eae3)

Co-authored-by: Anjali Bansal <anjali.mca17.du@gmail.com>
2019-09-11 16:36:41 +01:00
Miss Islington (bot) 4c2fa5c474 bpo-33459: Fix "tuple displays" term in Expressions.rst (GH-6760) (GH-15939)
https://bugs.python.org/issue33459

Automerge-Triggered-By: @matrixise
(cherry picked from commit dc26997109)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-09-11 15:37:49 +02:00
Miss Islington (bot) 0fd8c0560b bpo-35649: update http client example (GH-11441) (GH-15931)
(cherry picked from commit 62cf698142)

Co-authored-by: Ashwin Ramaswami <aramaswamis@gmail.com>
2019-09-11 15:13:55 +02:00
Vinay Sajip aca878ecf1
[3.7] bpo-35168: Make shlex.punctuation_chars read-only (GH-11631) (GH-15926)
(cherry picked from commit 972cf5c06a)

Co-authored-by: Alex <a.v.shkop@gmail.com>
2019-09-11 13:39:08 +01:00
Miss Islington (bot) d378fdb10a
bpo-25810: Clarify eval() docs, it does not keywords (GH-15173)
(cherry picked from commit 7a0023e8d1)

Co-authored-by: smokephil <smokephil@gmail.com>
2019-09-11 03:55:29 -07:00
Miss Islington (bot) 3cd147bf59
bpo-37585: Add clarification regarding comparing dict.values() (GH-14954)
(cherry picked from commit 6472ece5a0)

Co-authored-by: Kyle Stanley <aeros167@gmail.com>
2019-09-11 03:45:54 -07:00
Miss Islington (bot) 9210b5826f
bpo-16438: Doc: confusing text regarding numeric precedence corrected (GH-10521)
(cherry picked from commit 4576b5431b)

Co-authored-by: Anjali <anjali30malik@gmail.com>
2019-09-11 03:41:28 -07:00
Miss Islington (bot) 2a8560ae99 bpo-38034: Fix typo in logging.handlers.rst (GH-15708) (GH-15894)
(cherry picked from commit efd5741ae9)

Co-authored-by: wwuck <301402+wwuck@users.noreply.github.com>
2019-09-11 07:56:50 +01:00