Commit Graph

21431 Commits

Author SHA1 Message Date
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
Miss Islington (bot) 68833dcbd4 Clarify ValueError's broad applicability (GH-8313) (GH-8315)
(cherry picked from commit feabae9617)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2018-07-17 13:22:50 -07:00
Miss Islington (bot) bfa8a358e2 bpo-34123: Fix missed documentation update for dict.popitem(). (GH-8292) (GH#8307) 2018-07-16 19:08:13 -07:00
Miss Islington (bot) 43c2fabb2f bpo-34124: Fix markup of message_from_binary_file() signature (GH-8297)
(cherry picked from commit c9265c1534)

Co-authored-by: Jon Ribbens <jribbens@gmail.com>
2018-07-16 21:43:41 +03:00
Miss Islington (bot) 08c1da7103
bpo-4260: Document that ctypes.xFUNCTYPE are decorators (GH-7924)
(cherry picked from commit 379e9d639a)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-13 06:35:31 -07:00
Miss Islington (bot) 151820e7a0
bpo-34083: Update dict order in Functional HOWTO (GH-8230)
(cherry picked from commit 5e5bbbec46)

Co-authored-by: Stig Johan Berggren <stigjb@gmail.com>
2018-07-11 04:21:52 -07:00
Miss Islington (bot) 6b1b6e4385
Doc: Point to Simple statements section instead of PEP (GH-8238)
(cherry picked from commit 33aefad342)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-11 03:32:31 -07:00
Miss Islington (bot) bcea15a611 Dataclasses: Fix example on 30.6.8, add method should receive a list rather than an integer. (GH-8038) (GH-8237)
Change example function to append rather than add lists.
(cherry picked from commit da5e9476bb)

Co-authored-by: Tom Faulkner <tomfaulkner@gmail.com>
2018-07-11 06:11:11 -04:00
Miss Islington (bot) c87b1aabbd
Fix documentation for input and output tutorial (GH-8231)
The ValueError message ends with a period.
(cherry picked from commit 9cffdbffc3)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2018-07-10 17:51:03 -07:00
Miss Islington (bot) 5cca6f9fbe
bpo-34009: Expand on platform support changes (GH-8022)
Many users won't realise the implications the OpenSSL 1.0.2
minimum version requirement has when it comes to Ubuntu
14.04 and Debian 8, so expand on that in the platform support
section.

Also explicitly note the non-ASCII-based locale requirement for
full Unicode text handling support on non-Windows systems.
(cherry picked from commit 5fe7c98a54)

Co-authored-by: Nick Coghlan <ncoghlan@gmail.com>
2018-07-10 06:24:06 -07:00
Miss Islington (bot) 1b6e217304
bpo-34067: Include a more easily understood example for nullcontext (GH-8158)
Include a more easily understood example for nullcontext
(cherry picked from commit c287545d62)

Co-authored-by: Daniel Porteous <danielporteous1@gmail.com>
2018-07-09 07:11:42 -07:00
Miss Islington (bot) 80a5f04592
bpo-28626: rearrange discussion of output formatting to encourage f-strings (GH-6036)
The 'output formatting' section of the tutorial talks a lot about manual formatting with things like .rjust() and .zfill(), with only a passing reference to 3.6's new f-strings.

This doesn't drop all of the old material, but it does rearrange the topics into a more modern order: f-strings first, discussing formatting specifiers a bit; then calling .format(); finally manual formatting with .ljust().
(cherry picked from commit ced350b195)

Co-authored-by: Andrew Kuchling <amk@amk.ca>
2018-07-09 06:52:48 -07:00