Commit graph

20509 commits

Author SHA1 Message Date
Miss Islington (bot)
3bd749b212 bpo-32720: Fixed the definition for width and precision in format mini-language doc (GH-5482) (GH-5525)
Changed the definition of width and precision from "integer" to "digit+" in format mini-language doc.
(cherry picked from commit 8b5fa289fd)

Co-authored-by: nathankerr96 <nathankerr96@gmail.com>
2018-02-04 01:26:16 -05:00
Terry Jan Reedy
c90a5dec03
[3.6] bpo-32746: Fix multiple typos (GH-5144) (GH-5522)
Fix typos found by codespell in docs, docstrings, and comments.
Fixes for the following files were in post-3.6 code and not backported:
Lib/ctypes/_aix.py (new), Lib/test/test_concurrent_futures.py,
Modules/_asynciomodule.c, Modules/_pickle.c, Objects/obmalloc.c.

(cherry picked from commit c3d9508ff2)
2018-02-03 21:00:24 -05:00
Ned Deily
0cb82eb7e5 Update Doc build for split off of 3.7 branch 2018-02-03 16:28:44 -05:00
Miss Islington (bot)
7eb3d1e7da bpo-32739: Show default value for rotate() (GH-5485) (GH-5515)
(cherry picked from commit 589c718a8e)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2018-02-03 10:27:40 -08:00
Barry Warsaw
a71397fb66
[3.6] bpo-32303 - Consistency fixes for namespace loaders (GH-5481) (#5504)
* Make sure ``__spec__.loader`` matches ``__loader__`` for namespace packages.
* Make sure ``__spec__.origin` matches ``__file__`` for namespace packages.

https://bugs.python.org/issue32303
https://bugs.python.org/issue32305.
(cherry picked from commit bbbcf8693b)

Co-authored-by: Barry Warsaw <barry@python.org>
2018-02-02 23:21:14 -05:00
Terry Jan Reedy
fbf8e823c0
[3.6] bpo-32614: Modify re examples to use a raw string to prevent wa… …rning (GH-5265) (GH-5500)
Modify RE examples in documentation to use raw strings to prevent DeprecationWarning.
Add text to REGEX HOWTO to highlight the deprecation.  Approved by Serhiy Storchaka.

(cherry picked from commit 66771422d0)
2018-02-02 17:37:30 -05:00
Serhiy Storchaka
8cf7ebb32d
[3.6] bpo-32565: Add missed versionadded directives for all new opcodes. (GH-5199). (GH-5471)
(cherry picked from commit 12e7cd8a51)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-02-01 14:47:22 +02:00
Miss Islington (bot)
581ce25e1f bpo-32735: Fix typo in f-strings datetime format specifier example (GH-5464) (GH-5465)
The f-string example for using datetime format specifier does not match the given output.
Changed the format from %b to %B so it matches the output of "January".
(cherry picked from commit b299393cc3)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-01-31 17:17:02 -05:00
Miss Islington (bot)
04f99ba9d7 bpo-32701: Clarify the quotetabs flag in quopri documentation (GH-5401) (GH-5438)
(cherry picked from commit 9424dcbb3e)

Co-authored-by: Julien Palard <julien@palard.fr>
2018-01-29 20:16:21 -08:00
Miss Islington (bot)
5869861823 Document the error return of PyLong_As* APIs. (GH-5396) (#5404)
Document the error return of PyLong_As* APIs.

A frequent Python C API usage error is neglecting to check the return
value and/or PyErr_Occurred().
(cherry picked from commit f5b04a360e)
2018-01-29 09:24:11 -08:00
Miss Islington (bot)
190de183e5 Fix minor markup typo (GH-5407) (#5416)
(cherry picked from commit 2a3260bb03)
2018-01-29 01:24:09 -08:00
Miss Islington (bot)
33febfb039 Fix PyTrace_RETURN documentation (GH-5384) (GH-5386)
It will be triggered when propagating an exception.
(cherry picked from commit 79db11ce99)
2018-01-28 23:33:23 +08:00
Miss Islington (bot)
854f0424de bpo-32687: Fix wrong meaning of args for PyTrace_LINE/CALL in documentation (GH-5361) (GH-5377)
(cherry picked from commit 9ed0aee27c)
2018-01-28 16:41:05 +08:00
Miss Islington (bot)
0135dfdc1f Minor grammar fixes to License.rst (GH-1174) (GH-5373)
(cherry picked from commit 8312fba0a1)
2018-01-27 21:06:12 -08:00
Miss Islington (bot)
d331515847 [3.6] bpo-32664: Add missing "|" connector in Exceptions doc (GH-1173) (GH-5372)
(cherry picked from commit 992ae6444c)
2018-01-27 19:52:52 -08:00
Cheryl Sabella
8f68cb7db3 [3.6] bpo-27505: Retrofit module __class__ documentation from 3.7 (GH-5321)
The module `__class__` attribute documentation added to 3.7 for PEP 562
(dynamic module attributes) also applies to earlier versions. This backports
that subset of the new docs to the 3.6 branch so that it will appear in the
main online documentation and in the final 3.6 binary release.

Patch by Cheryl Sabella.
2018-01-27 12:45:24 +10:00
Bo Bayles
995c60d265 [3.6] bpo-32304: Fix distutils upload for tar files ending with b'\r' (GH-5264) (GH-5330)
Patch by Bo Bayles.
2018-01-26 21:18:58 -05:00
Miss Islington (bot)
196b8cbab2 bpo-32651 Recommend getpass.getuser() (GH-5301) (#5304)
* bpo-32651 - In the documentation for os.getlogin(), recommend getpass.getuser()
(cherry picked from commit d499031f5f)
2018-01-24 14:09:56 -05:00
Xiang Zhang
fd844efa9c
bpo-17799: Explain real behaviour of sys.settrace and sys.setprofile (GH-4056) (#5298)
(cherry picked from commit 131fd7f96c)
2018-01-24 22:44:53 +08:00
Victor Stinner
b92c159efa
[3.6] bpo-32555: Fix locale encodings (#5193)
On FreeBSD and Solaris, os.strerror() now always decode the byte
string from the current locale encoding, rather than using
ASCII/surrogateescape in some cases.

Changes:

* Add _Py_DecodeLocaleEx() and _Py_EncodeLocaleEx() which has an
  additional current_locale parameter.
* PyUnicode_DecodeLocale(), PyUnicode_DecodeLocaleAndSize() and
* PyUnicode_EncodeLocale() now always use the current locale
* encoding, instead of using Py_DecodeLocale()/Py_EncodeLocale().
* Document encoding in Py_DecodeLocale() and Py_EncodeLocale()
  documentations.
* Add USE_FORCE_ASCII define to not define
  decode_ascii_surrogateescape() on Android.
2018-01-15 23:43:24 +01:00
Victor Stinner
5f959c4f9e
[3.6] bpo-31900: Fix localeconv() encoding for LC_NUMERIC (#4174) (#5192)
* Add _Py_GetLocaleconvNumeric() function: decode decimal_point and
  thousands_sep fields of localeconv() from the LC_NUMERIC encoding,
  rather than decoding from the LC_CTYPE encoding.
* Modify locale.localeconv() and "n" formatter of str.format() (for
  int, float and complex to use _Py_GetLocaleconvNumeric()
  internally.

(cherry picked from commit cb064fc232)
2018-01-15 23:23:47 +01:00
Miss Islington (bot)
fb8569e36f bpo-26330: Update shutil.disk_usage() documentation (GH-5184) (GH-5188)
Clarify that on Windows, path must be a directory.
On Unix, path can be a file or a directory.
(cherry picked from commit ee3b83547c)
2018-01-15 06:32:11 -08:00
Miss Islington (bot)
bb80645d06 bpo-15221: Update os.path.is*() documentation (GH-5185) (GH-5186)
`os.path.is*()` can return False if the file can't be accessed.
The behaviour is documented in details in `os.path.exists()`.
Link to `os.path.exists()` from `os.path.is*()`.
(cherry picked from commit b3dd18d403)
2018-01-14 21:44:49 -08:00
Miss Islington (bot)
cf4cd4bccb Add itertools recipe for directly finding the n-th combination (GH-5161) (#5174)
(cherry picked from commit d37258dd2e)
2018-01-13 11:21:15 -08:00
Miss Islington (bot)
29b1aff718 Improve enum.Flag code example (GH-5167) (GH-5171)
The code example that demonstrate how to use enum.Flag was missing
the import of enum.auto.
(cherry picked from commit 0f31c74fcf)
2018-01-12 20:23:21 -08:00
Miss Islington (bot)
22b1050672 Lexical Analysis ref doc: Fix a typo in the string concatenation internal link (GH-5157) (GH-5160)
In lexical analysis reference documentation, the internal link to
the string literal concatenation section was written as`.. _string-catenation:`.
Changed that to `.. _string-concatenation:`.
(cherry picked from commit 3764bb075a)
2018-01-11 22:50:45 -08:00
Miss Islington (bot)
e29573910c advance copyright years to 2018 (GH-5094) (#5104)
(cherry picked from commit 65f2a6dcc2)
2018-01-05 23:12:14 -08:00
Serhiy Storchaka
1e6d8525f9
bpo-32211: Document the existing bug in re.findall() and re.finditer(). (#4695) 2018-01-04 11:08:24 +02:00
Miss Islington (bot)
f24c1857a8 bpo-32452: clarify term 'brackets' in generator tutorial (GH-5079) (#5081)
Updates documentation for generator expressions in classes tutorial: Clarify usage of ambiguous term "brackets" by replacing with "square brackets". Updated subsequent lines to respect line breaks. (GH-5079)
(cherry picked from commit f190eb59e6)
2018-01-02 08:36:06 -05:00
Miss Islington (bot)
45588c6dd1 Fix trivial typo in pickle.rst (GH-4955) (#4958)
(cherry picked from commit a8d25a1645)
2017-12-21 11:11:06 +02:00
Miss Islington (bot)
4aa84e7285 bpo-32306: Clarify c.f.Executor.map() documentation (GH-4947) (#4948)
The built-in map() function collects function arguments lazily, but concurrent.futures.Executor.map() does so eagerly.
(cherry picked from commit a7a751dd7b)
2017-12-20 19:19:18 +01:00
Miss Islington (bot)
75d1ca26b0 Improve the F-strings and format specifier documentation (GH-4931) (GH-4933)
Mention that the format-specifier mini language in f-strings
is the same one used by str.format.
(cherry picked from commit f4e21a2a72)
2017-12-19 13:09:19 -08:00
Miss Islington (bot)
dc5770b161 bpo-32377: improve __del__ docs and fix mention about resurrection (GH-4927) (#4929)
* Fix GH-32377: improve __del__ docs and fix mention about resurrection

* Mention that CPython only calls __del__ once.
(cherry picked from commit 4b965930e8)
2017-12-19 20:00:13 +01:00
Miss Islington (bot)
dab4cf210c Minor wording tweak for itertools documentation (GH-4893) (#4894)
(cherry picked from commit 6693d7af66)
2017-12-15 13:28:50 -08:00
Miss Islington (bot)
5a9f379435 F-strings docs: link to Format Specifiers (GH-4888) (GH-4889)
Link to the Format Specification Mini Language section from f-strings' documentation.
(cherry picked from commit d924fa523d)
2017-12-15 10:11:17 -08:00
Miss Islington (bot)
77bf6da725 bpo-28393: Update encoding lookup docs wrt bpo-27938 (GH-4871) (#4881)
(cherry picked from commit 297fd876aa)
2017-12-15 15:23:24 +01:00
Andrew Svetlov
28453feaa8
[3.6] bpo-32297: Fix misspellings in Python source code comments (GH-4803) (#4864)
* [3.6] bpo-32297: Few misspellings found in Python source code comments. (GH-4803)

* Fix multiple typos in code comments

* Add spacing in comments (test_logging.py, test_math.py)

* Fix spaces at the beginning of comments in test_logging.py.

(cherry picked from commit 53f7a7c281)
2017-12-14 16:19:51 +02:00
Miss Islington (bot)
4a97809a38 trivial: link updates in documentation (GH-2765) (#4835)
(cherry picked from commit 4f29f3c84b)
2017-12-13 14:45:19 +02:00
Miss Islington (bot)
b0358e8784 bpo-32284: Fix documentation of BinaryIO and TextIO (GH-4832) (#4833)
(cherry picked from commit c3e070f849)
2017-12-13 10:59:01 +02:00
Miss Islington (bot)
78cd00b799 bpo-31942: Document optional support of start and stop attributes in Sequence.index method (GH-4277) (#4811)
(cherry picked from commit 5ce0a2a100)
2017-12-12 11:58:26 +01:00
Miss Islington (bot)
0aa2a1d003 bpo-22671: Clarify and test default read method implementations (GH-4568) (#4796)
Original patch written by Martin Panter, enhanced by Sanyam Khurana.
(cherry picked from commit 1b74f9b77a)
2017-12-11 15:27:25 +01:00
Vinay Sajip
63868181a9
bpo-32212: Updated logging documentation to make parameter names more consistent with source. (GH-4765) (GH-4767)
(cherry picked from commit a9f8df646a)
2017-12-09 12:28:16 +00:00
Miss Islington (bot)
a04ca12e12 bpo-32208: update threading.Semaphore docs and add unit test (GH-4709) (#4750)
* fix issue32208: update threading.Semaphore docs and add unit test to validate correct behavior

* add test for blocking

* Update threading.rst

* semaphore: remove documentation validation tests and move 'return value' test to BaseSemaphore
(cherry picked from commit a0374dd34a)
2017-12-07 20:48:35 +02:00
Miss Islington (bot)
3b55416700 Add a missing space in tkinter documentation. (GH-4692) (GH-4722)
(cherry picked from commit ae342cf7de)
2017-12-04 21:16:20 -08:00
Miss Islington (bot)
2ad350a713 [3.6] bpo-31589 : Build PDF using xelatex for better UTF8 support. (GH-3940) (#4683)
Also addresses doc build failures documented in bpo-32200.
(cherry picked from commit 7324b5ce8e)
2017-12-02 17:35:08 -05:00
Miss Islington (bot)
5f6d2bb8cf Use raw strings in the re module examples. (GH-4616) (#4617)
(cherry picked from commit c615be5166)
2017-11-28 23:21:09 +02:00
Miss Islington (bot)
8a957534f5 bpo-32051: Fix name shadowing in multiprocessing docs (GH-4469)
(cherry picked from commit c172fc5031)
2017-11-27 04:22:50 +03:00
Miss Islington (bot)
cceb0f8d7b bpo-29879: Update typing documentation. (GH-4573) (GH-4574)
- Add "version added: 3.5.2" note where it was missing.
- Remove the mention that Reversible is new in 3.5.2
(cherry picked from commit 0cd2e81bea)
2017-11-26 14:27:44 -08:00
Miss Islington (bot)
6bce8ace76 [Doc] Update opcode for var-positional arguments (GH-4446) (#4457)
`BUILD_MAP_UNPACK_WITH_CALL` was duplicated as the opcode for both var-positional and var-keyword arguments. The opcode for the former was updated as `BUILD_TUPLE_UNPACK_WITH_CALL`.
(cherry picked from commit 0c71653cb8)
2017-11-25 17:57:41 +02:00
Miss Islington (bot)
db897b1961 Improve Scheduler Objects documentation. (GH-4556) (GH-4557)
Mention that the lower the priority number, the higher priority it represents.
(cherry picked from commit 9d5ec808de)
2017-11-24 21:48:26 -08:00