Commit graph

8565 commits

Author SHA1 Message Date
Miss Islington (bot)
3100b7e710
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:31 -07:00
Miss Islington (bot)
30f295b85e
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:27 -07:00
Andrés Delfino
0041d721a6 [3.6] bpo-5978: Document that profiling needs cmd/function to return (GH-8515)
<!-- 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 13:24:35 +01:00
Miss Islington (bot)
a096cc6c3b 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:31:11 -07:00
Miss Islington (bot)
5b3643d1a5 bpo-33468: Add try-finally contextlib.contextmanager example (GH-7816) (GH-8426)
(cherry picked from commit bde782bb59)

Co-authored-by: Matthias Bussonnier <bussonniermatthias@gmail.com>
2018-07-24 00:38:24 +03:00
Miss Islington (bot)
c774f76d21 Clarify ValueError's broad applicability (GH-8313) (GH-8317)
(cherry picked from commit feabae9617)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2018-07-17 13:24:27 -07:00
Miss Islington (bot)
f1ab9cac90 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 22:41:48 +03:00
Miss Islington (bot)
083a836937
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:54:18 -07:00
Miss Islington (bot)
b3cc7ca250
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:52:27 -07:00
Miss Islington (bot)
d73497ba52 bpo-26544: Fixed implementation of platform.libc_ver(). (GH-7684). (GH-8193) (GH-8195)
(cherry picked from commit 2a9b8babf0)
(cherry picked from commit 7c43b80150)
2018-07-09 14:38:27 +03:00
Miss Islington (bot)
336c715a82
Fix margin in sentinel and mock_open (GH-8188)
(cherry picked from commit f85af035c5)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-08 17:52:44 -07:00
Marcin Niemira
4041565348 bpo-34061: Document sqlite3.NotSupportedError (GH-8172)
(cherry picked from commit bc9aa813a3)

Co-authored-by: Marcin Niemira <marcin@niemira.net>
2018-07-08 16:58:49 +03:00
Benjamin Peterson
becb527767
[3.6] closes bpo-34050: Fix link in SSL docs (GH-8173) (GH-8178)
(cherry picked from commit 9c5ba09748)

Co-authored-by: Marcin Niemira <marcin@niemira.net>
2018-07-07 16:03:37 -07:00
Miss Islington (bot)
770937b6fd
bpo-33804: Document that the argument for io.TextIOBase.read() is optional (GH-7510)
(cherry picked from commit b6bb77c2b8)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-07 13:45:07 -07:00
Miss Islington (bot)
3271fba16e
Add missing closing parentheses (GH-8144)
(cherry picked from commit 03dd0e794e)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-07 12:34:43 -07:00
Miss Islington (bot)
dc33d4ac6f
Fix moduleauthor/sectionauthor directives in Enum (GH-8117)
(cherry picked from commit 2d748389dc)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-07 12:30:40 -07:00
Dong-hee Na
cad4a27585 [3.6] bpo-34065: Improve the markup of logging.basicConfig() arguments (GH-8153). (GH-8155)
(cherry picked from commit 2800dcf656)

Co-authored-by: Dong-hee Na <donghee.na92@gmail.com>
2018-07-07 19:11:22 +03:00
Miss Islington (bot)
55f39bdabc bpo-30516: Fix documentation issue with -timedelta in datetime (GH-7348) (GH-8092)
This commit fixes the -timedelta overfllow issue not documented properly.

Signed-off-by: Farhaan Bukhsh <farhaan.bukhsh@gmail.com>
(cherry picked from commit 5b6e49a139)

Co-authored-by: Farhaan Bukhsh <farhaan.bukhsh@gmail.com>
2018-07-05 00:04:03 +01:00
Miss Islington (bot)
f55a818954 bpo-34018: Doc'd that type names of SQLite converters are case-insensitive. (GH-8042) (GH-8067)
(cherry picked from commit 831c29721d)

Co-authored-by: Sergey Fedoseev <fedoseev.sergey@gmail.com>
2018-07-03 15:37:26 +03:00
Miss Islington (bot)
b1707abd74
Doc: Remove unused image file (GH-8027)
(cherry picked from commit fe524df37c)

Co-authored-by: INADA Naoki <methane@users.noreply.github.com>
2018-06-30 11:31:17 -07:00
Tal Einat
db7ac30ef5
[3.6] bpo-32568: make select.epoll() and its docs consistent (GH-7840) (GH-8025)
* `flags` is indeed deprecated, but there is a validation on its value for
  backwards compatibility reasons.  This adds mention of this in the docs.
* The docs say that `sizehint` is deprecated and ignored, but it is still
  used when `epoll_create1()` is unavailable. This adds mention of this in
  the docs.
* `sizehint=-1` is acceptable again, and is replaced with `FD_SETSIZE-1`.
  This is needed to have a default value available at the Python level,
  since `FD_SETSIZE` is not exposed to Python. (see: bpo-31938)
* Reject `sizehint=0` since it is invalid to pass on to `epoll_create()`.

The relevant tests have also been updated.

(cherry picked from commit 0cdf5f4289)
2018-06-30 16:15:53 +03:00
Miss Islington (bot)
a73027918a
Fix the indentation in the documentation of bin() and hash() (GH-7998)
(cherry picked from commit bda9c3eae3)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-06-29 03:17:43 -07:00
Miss Islington (bot)
8fd8cfa369 [3.6] bpo-33573: docs to suggest median() alternatives for non-numeric data (GH-7587) (GH-7907)
(cherry picked from commit fdd6e0bf18)
2018-06-25 14:27:01 +03:00
Miss Islington (bot)
ac5a6e35ef bpo-33952: Fix typo in str.upper() documentation (GH-7898) (GH-7904)
(cherry picked from commit 4a6e746079)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-06-25 13:44:16 +03:00
Miss Islington (bot)
73848e028d bpo-33943: Add references in the docs for logging.basicConfig (GH-7858) (GH-7899)
Adds references to info about file modes, `time.strftime()`, string formatting
syntaxes, and logging levels.

(cherry picked from commit a8ddf85a84)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-06-25 09:31:24 +03:00
Andrés Delfino
c45cb47907 bpo-33885: Replace "hook function" with "callable" (GH-7765) 2018-06-22 17:10:23 -04:00
Miss Islington (bot)
b225cb770f bpo-33894: Clarified the tempfile.tempdir documentation (GH-7829) (GH-7842)
(cherry picked from commit 940ae60856)

Co-authored-by: Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి) <srinivasreddy@users.noreply.github.com>
2018-06-21 04:05:07 -04:00
Miss Islington (bot)
f14e8eaaa5
bpo-33892: Doc: Use gender neutral words (GH-7770)
(cherry picked from commit 5092439c2c)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-06-17 21:54:51 -07:00
Xtreak
c5ff553ae7 [3.6] bpo-33859: Fix spelling mistakes in docs. (GH-7691). (GH-7750)
(cherry picked from commit c151f7846d)

Co-authored-by: Xtreak <tirkarthi@users.noreply.github.com>
2018-06-16 09:33:16 +03:00
Miss Islington (bot)
2ac5242352 doc: Fix small typos in library/multiprocessing (GH-698) (GH-7721)
(cherry picked from commit 5619ab2db3)

Co-authored-by: Sylvain Bellemare <sbellem@gmail.com>
2018-06-15 22:27:48 +02:00
Miss Islington (bot)
ae4b2af42c bpo-33854: Add PEP 461 title to 'See also' note (GH-7688) (GH-7720)
(cherry picked from commit a9d0b34a5c)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-06-15 16:14:53 -04:00
Victor Stinner
142e3c08a4
[3.6] bpo-32356: idempotent pause_/resume_reading (GH-4914) (GH-7629)
Backport note: don't add new is_reading() method from master to 3.6.

(cherry picked from commit d757aaf9dd)
2018-06-13 12:05:15 +02:00
Miss Islington (bot)
961332dfd3
bpo-31378: Document sqlite3.OperationalError exception (GH-7677)
(cherry picked from commit 71ede00f14)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2018-06-13 02:30:09 -07:00
Miss Islington (bot)
439a9b6998
bpo-33828: Add missing versionchanged note for string.Formatter. (GH-7668)
string.Formatter auto-numbering feature was added in 3.4 and there
is no versionchanged note in its documentation, making the documentation
ambiguous about which version the feature is available.
(cherry picked from commit b9d8ad5130)

Co-authored-by: Xiang Zhang <angwerzx@126.com>
2018-06-12 19:11:25 -07:00
Miss Islington (bot)
63dd1f70c1 bpo-27397: Make email module properly handle invalid-length base64 strings (GH-7583) (GH-7665)
When attempting to base64-decode a payload of invalid length (1 mod 4),
properly recognize and handle it.  The given data will be returned as-is,
i.e. not decoded, along with a new defect, InvalidBase64LengthDefect.
(cherry picked from commit c3f55be7dd)

Co-authored-by: Tal Einat <taleinat+github@gmail.com>
2018-06-12 16:46:26 +03:00
Ned Deily
e25757408d
bpo-31432: Clarify ssl CERT_NONE/OPTIONAL/REQUIRED docs. (GH-3530) (GH-7652)
The documentation for CERT_NONE, CERT_OPTIONAL, and CERT_REQUIRED were
misleading and partly wrong. It fails to explain that OpenSSL behaves
differently in client and server mode. Also OpenSSL does validate the
cert chain everytime. With SSL_VERIFY_NONE a validation error is not
fatal in client mode and does not request a client cert in server mode.
Also discourage people from using CERT_OPTIONAL in client mode.
2018-06-11 21:44:58 -04:00
Miss Islington (bot)
bbbc3d99dc bpo-30820: Remove incorrect docs for email.contentmanager.raw_data_manager (GH-7631) (#7634)
The docs claimed that a list of EmailMessage objects could be
passed to set_content(), but this was never implemented.
(cherry picked from commit 2c071cebe6)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2018-06-11 12:11:52 -04:00
Miss Islington (bot)
1d4089b5d2 bpo-33812: Corrected astimezone for naive datetimes. (GH-7578) (GH-7601)
A datetime object d is aware if d.tzinfo is not None and
d.tzinfo.utcoffset(d) does  not return None. If d.tzinfo is None,
or if d.tzinfo is not None but d.tzinfo.utcoffset(d) returns None,
 d is naive.

This commit ensures that instances with non-None d.tzinfo, but
d.tzinfo.utcoffset(d) returning None are treated as naive.

In addition, C acceleration code will raise TypeError if
d.tzinfo.utcoffset(d) returns an object with the type other than
timedelta.

* Updated the documentation.

Assume that the term "naive" is defined elsewhere and remove the
not entirely correct clarification.  Thanks, Tim.
(cherry picked from commit 877b23202b)

Co-authored-by: Alexander Belopolsky <abalkin@users.noreply.github.com>
2018-06-10 18:03:31 -04:00
Miss Islington (bot)
08a1b13392
bpo-33610: Update IDLE Code Context doc entry (GH-7597)
Users can now click on context lines.
(cherry picked from commit af4b0130d4)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2018-06-10 13:11:20 -07:00
Miss Islington (bot)
a5f0a8eeab
Fix typo in object.__getnewargs__() documentation (GH-7554)
(cherry picked from commit 0e0534c402)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-06-09 18:00:47 -07:00
Miss Islington (bot)
a0accc0f8e
bpo-31215: Add version changed notes for OpenSSL 1.1.0 compatibility (GH-7346)
(cherry picked from commit 9ef1b0690b)

Co-authored-by: Mayank Singhal <17mayank.singhal@gmail.com>
2018-06-08 03:22:39 -07:00
Berker Peksag
279564431e
[3.6] bpo-32392: Document env keyword argument of subprocess.run() (GH-7289)
(cherry picked from commit af1ec97a6d)

Conflicts:

	Doc/library/subprocess.rst
2018-06-07 22:22:35 +03:00
Miss Islington (bot)
21f2553482
bpo-17909: Document that json.load can accept a binary IO (GH-7366)
(cherry picked from commit bb6366bd75)

Co-authored-by: Anthony Sottile <asottile@umich.edu>
2018-06-07 03:21:20 -07:00
Miss Islington (bot)
889a1ef683
bpo-27902: Add compatibility note to Profile docs (GH-7295)
(cherry picked from commit f7745e1dcb)

Co-authored-by: Tobias Kunze <r@rixx.de>
2018-06-04 10:30:34 -07:00
Miss Islington (bot)
6a43d5f4fb
bpo-33640, uuid.UUID doc: document endian of bytes parameter (GH-7263)
The bytes parameter uses big endian.
(cherry picked from commit b75ec08567)

Co-authored-by: Farhaan Bukhsh <farhaan.bukhsh@gmail.com>
2018-06-04 10:18:22 -07:00
Miss Islington (bot)
db30390858
bpo-23495: Correct the documentation for writerows() of csv Writer objects (GH-6316)
`writerows()` takes an iterable.
(cherry picked from commit a801cf164b)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2018-06-02 08:37:28 -07:00
Miss Islington (bot)
1df877caad bpo-32519: Removed misleading sentence from EnvBuilder documentation. (GH-7296) (GH-7299)
(cherry picked from commit c0d341d49b)

Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2018-06-01 18:56:47 +01:00
Miss Islington (bot)
461ad598d1 bpo-33400: Removed references to RFC3339 and ISO8601 from the logging documentation. (GH-7297) (GH-7303)
(cherry picked from commit 23cee80cfa)

Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2018-06-01 18:55:10 +01:00
Serhiy Storchaka
55d9e865cb
[3.6] bpo-33641: Convert RFC references into links. (GH-7103) (GH-7276)
85% of them are already links.
(cherry picked from commit 0a36ac1a09)
2018-05-31 09:11:07 +03:00
Yury Selivanov
3b263e65a8
bpo-32684: Fix gather to propagate cancel of itself with return_exceptions (GH-7224) 2018-05-29 19:20:01 -04:00