Commit Graph

21632 Commits

Author SHA1 Message Date
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