summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* bpo-25655: Improve Win DLL loading failures doc (GH-22372)Miss Skeleton (bot)2020-10-221-0/+15
| | | | | | | | | Add documentation to help diagnose CDLL dependent DLL loading errors on windows for OSError with message: "[WinError 126] The specified module could not be found" This error is otherwise difficult to diagnose. (cherry picked from commit b6f2fc90409e291822166d74ce7402e0ef4dba91) Co-authored-by: Philippe Ombredanne <pombredanne@gmail.com>
* [3.8] Remove 3.5 from Doc version switcher in master. (GH-22886) (#22889)larryhastings2020-10-222-2/+0
| | | (cherry picked from commit 283f9a253b4ff4df728558205629b3bb3af6e47f)
* bpo-41910: specify the default implementations of object.__eq__ and ↵Miss Skeleton (bot)2020-10-221-6/+8
| | | | | | | object.__ne__ (GH-22874) (#22877) See Objects/typeobject.c:object_richcompare() for the implementation of this in CPython. Co-authored-by: Brett Cannon <brett@python.org>
* bpo-35181: Correct importlib documentation for some module attributes (GH-15190)Miss Skeleton (bot)2020-10-212-21/+11
| | | | | | | | | | | | | | | | | | @ericsnowcurrently This PR will change the following: In the library documentation importlib.rst: - `module.__package__` can be `module.__name__` for packages; - `spec.parent` can be `spec.__name__` for packages; - `spec.loader` is not `None` for namespaces packages. In the language documentation import.rst: - `spec.loader` is not `None` for namespace packages. Automerge-Triggered-By: GH:warsaw (cherry picked from commit 27f1bd8787d24ac53cc3dc6ea5eb00b8a3499839) Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
* [3.8] bpo-41959: Fix grammar around class asyncio.MultiLoopChildWatcher text ↵Miss Skeleton (bot)2020-10-211-1/+1
| | | | | | | | | (GH-22580) (GH-22866) While translating the following document to Spanish we found there is a grammar issue on the original documentation. (cherry picked from commit caff2934f46510920a6169e192707d59e9c55f6b) Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
* [3.8] bpo-39416: Document some restrictions on the default string ↵Miss Skeleton (bot)2020-10-211-0/+18
| | | | | | | | | | | | | | | | | | | | | | representations of numeric classes (GH-18111) (GH-22861) [[bpo-39416]()](): Document string representations of the Numeric classes This is a change to the specification of the Python language. The idea here is to put sane minimal limits on the Python language's default representations of its Numeric classes. That way "Marty's Robotic Massage Parlor and Python Interpreter" implementation of Python won't do anything too crazy. Some discussion in the email thread: Subject: Documenting Python's float.__str__() https://mail.python.org/archives/list/python-dev@python.org/thread/FV22TKT3S2Q3P7PNN6MCXI6IX3HRRNAL/ (cherry picked from commit c60394c7fc9cc09b16e9675a3eeb5844b6d8523f) Co-authored-by: kpinc <kop@karlpinc.com> Automerge-Triggered-By: GH:merwok
* Doc: Fix a typo/error in the docs for cached bytecode (GH-22445)Miss Skeleton (bot)2020-10-211-1/+1
| | | | | (cherry picked from commit cb115e36e1aba04b90b0ecac6f043e60064ac65b) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* Doc: Do not suggest `s[::-1]` for reversed order (GH-22457)Miss Skeleton (bot)2020-10-212-7/+1
| | | | | (cherry picked from commit fb2e94692e3a8eb66915575f4a122d56fe8999a0) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* Doc: Remove old Python version from future stmt (GH-21802)Miss Skeleton (bot)2020-10-211-2/+2
| | | | | (cherry picked from commit eba109a28f48b20b05f08abbe6604eebb07788f9) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* bpo-41646: Mention path-like objects support in the docs for shutil.copy() ↵Miss Skeleton (bot)2020-10-211-3/+3
| | | | | | | (GH-22208) (cherry picked from commit 8f2b991eef062c22c429a96983c78be007180b66) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-41192: Add documentation of undocumented audit events (GH-22832)Miss Skeleton (bot)2020-10-205-2/+56
| | | | (cherry picked from commit 3f7e990fd49dbabc1dde41ce58c1bdda9f56ead7)
* bpo-41192: Clarify the sys module's description of the auditing feature ↵Miss Skeleton (bot)2020-10-201-10/+25
| | | | | | | | | | (GH-22820) Co-authored-by: Éric Araujo <merwok@netwok.org> (cherry picked from commit 0c37269be7065b9b15b7b3a4406084f9535a793a) Co-authored-by: Andrew Kuchling <amk@amk.ca> Co-authored-by: Andrew Kuchling <amk@amk.ca>
* Doc: Add missing spaces after period for `posix_spawn` (GH-22730)Miss Skeleton (bot)2020-10-201-2/+2
| | | | | (cherry picked from commit 5b57fa69408c4856bf0ae02f2eaa3db1ef980ea6) Co-authored-by: Tomer Cohen <tomer@users.noreply.github.com>
* bpo-30612: Tweak Windows registry path syntax in the docs (GH-20281)Miss Skeleton (bot)2020-10-201-3/+3
| | | | | (cherry picked from commit ff1ae3dd334faa2006394c2318db385cdc42030a) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-40901: Describe what "interface name" means on Windows (GH-20694)Miss Skeleton (bot)2020-10-191-0/+19
| | | | | (cherry picked from commit f85658a09878c658ae0e0590bfa30e4ce51c9a04) Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
* bpo-41217: Fix incorrect note in the asyncio.create_subprocess_shell() docs ↵Miss Skeleton (bot)2020-10-191-4/+2
| | | | | | | | (GH-21360) On Windows, the default asyncio event loop is ProactorEventLoop (as of 3.8). (cherry picked from commit 4dfb190a33a1deac60306f15d52d2fe11fb93464) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-41292: Fixes dead link to cx_freeze from Windows FAQ (GH-21463)Miss Skeleton (bot)2020-10-191-1/+1
| | | | | (cherry picked from commit 33242a9328cb3912f02819d2d092bf89681000b2) Co-authored-by: Michel Samia <m.samia@seznam.cz>
* Link to the msvcrt module from the Windows FAQ (GH-22268)Miss Skeleton (bot)2020-10-191-1/+1
| | | | | (cherry picked from commit 5d9e6575177f3e5f9aa20d6a08ae1204f122e672) Co-authored-by: abdo <abd.nh25@gmail.com>
* bpo-41192: Fix some broken anchors for audit event entries (GH-21310) (GH-22770)Miss Skeleton (bot)2020-10-193-4/+3
| | | | | (cherry picked from commit ebc8c3828779374b9be4fae5c8ffc0059d36ac8c) Co-authored-by: Saiyang Gou <gousaiyang@163.com>
* [3.8] bpo-41855: Fix duplicate results in FastPath.zip_children() (#22404)Jason R. Coombs2020-10-152-23/+18
| | | | | | | * bpo-41855: Backport fixes from importlib_metadata 1.5.2. * Add blurb. * Add anchor for finders and loaders
* bpo-41376: Fix the documentation of `site.getusersitepackages()` (GH-21602) ↵Miss Skeleton (bot)2020-10-111-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | (GH-22592) `site.getusersitepackages()` returns the location of the user-specific site-packages directory even when the user-specific site-packages is disabled. ``` $ python -s -m site sys.path = [ '/home/user/conda/lib/python37.zip', '/home/user/conda/lib/python3.7', '/home/user/conda/lib/python3.7/lib-dynload', '/home/user/conda/lib/python3.7/site-packages', ] USER_BASE: '/home/user/.local' (exists) USER_SITE: '/home/user/.local/lib/python3.7/site-packages' (doesn't exist) ENABLE_USER_SITE: False ``` It was not practical to prevent the function from returning None if user-specific site-packages are disabled, since there are other uses of the function which are relying on this behaviour (e.g. `python -m site`). (cherry picked from commit 35f041dd0171f575fc3adce1709b31fdf45a5ff6) Co-authored-by: Phil Elson <pelson.pub@gmail.com> Co-authored-by: Phil Elson <pelson.pub@gmail.com>
* [3.8] [doc] Fix link to abc.collections.Iterable (GH-22502) (#22504)Andre Delfino2020-10-111-1/+1
| | | | | | Automerge-Triggered-By: @gvanrossum. (cherry picked from commit d4b9edd5052a2d9ae3d2be69975cc933afb37737) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* Fix incorrect parameter name (GH-22613)Miss Skeleton (bot)2020-10-101-1/+1
| | | | | | Automerge-Triggered-By: @Mariatta (cherry picked from commit a42759351bff7b07fa8bf2cece0088f8539721d1) Co-authored-by: Xie Yanbo <xieyanbo@gmail.com>
* bpo-41584: clarify when the reflected method of a binary arithemtic operator ↵Miss Skeleton (bot)2020-10-051-7/+8
| | | | | | | is called (GH-22505) (cherry picked from commit d02d824e05e2cb86f4df381be18832e76e2c475f) Co-authored-by: Brett Cannon <brett@python.org>
* bpo-41774: Tweak new programming FAQ entry (GH-22562)Miss Skeleton (bot)2020-10-051-1/+1
| | | | | | Remove mention of space in "remove multiple items from list". (cherry picked from commit 060937da988347a887a5f165b023d972fcb97802) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-41892: Clarify that an example in the ElementTree docs explicitly avoids ↵Miss Skeleton (bot)2020-10-041-0/+6
| | | | | | | modifying an XML tree while iterating over it. (GH-22464) (cherry picked from commit 40db798692ca783fc2163656f196ac77e8b9e792) Co-authored-by: scoder <stefan_ml@behnel.de>
* bpo-41898: add caveat on root logger seeing all messages in assertLogs doc ↵Miss Skeleton (bot)2020-10-041-1/+2
| | | | | (GH-22526) (GH-22537) (cherry picked from commit 1ed54435268b285964141fb74d47ceaa33ea79ab)
* [doc] Fix link to abc.collections.Iterable (GH-22520)Miss Skeleton (bot)2020-10-031-2/+2
| | | | | | | | Missed this occurrence before, sorry. Also changed "the PEP" to "PEP". Automerge-Triggered-By: @gvanrossum (cherry picked from commit 3fe614893742faee3c64e6d974e11329a496424f) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* bpo-40833: Clarify Path.rename doc-string regarding relative paths (GH-20554)Miss Skeleton (bot)2020-10-031-0/+8
| | | | | (cherry picked from commit f97e42ef4d97dee64f45ed65170a6e77c8e46fdf) Co-authored-by: Ram Rachum <ram@rachum.com>
* bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' (GH-22291)Miss Islington (bot)2020-10-021-4/+6
| | | | | (cherry picked from commit 20ce62f00957d11f24f6449cd5c0ef5dd67174d4) Co-authored-by: Campbell Barton <ideasman42@gmail.com>
* Fix grammar in secrets module documentation (GH-22467)Miss Islington (bot)2020-09-301-1/+1
| | | | | | From `In particularly,` to `In particular,` (cherry picked from commit 63298930fb531ba2bb4f23bc3b915dbf1e17e9e1) Co-authored-by: Max Smolens <msmolens@users.noreply.github.com>
* bpo-41774: Add programming FAQ entry (GH-22402)Miss Islington (bot)2020-09-291-0/+15
| | | | | | | In the "Sequences (Tuples/Lists)" section, add "How do you remove multiple items from a list". (cherry picked from commit 5b0181d1f6474c2cb9b80bdaf3bc56a78bf5fbe7) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-41858: Clarify line in optparse doc (GH-22407)Miss Islington (bot)2020-09-271-1/+1
| | | | | | The existing line is easily read as being incomplete. (cherry picked from commit 00eb063b6600fdb4ba5cfb99da83cc1660ec69bf) Co-authored-by: Emmanuel Arias <eamanu@yaerobi.com>
* bpo-33822: Update IDLE section of What's New 3.8 (GH-22383)Miss Islington (bot)2020-09-231-0/+10
| | | | | (cherry picked from commit 9c4eac7f02ddcf32fc1cdaf7c08c37fe9718c1fb) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-37062: Enum: add extended AutoNumber example (GH-22349) (GH-22369)Miss Islington (bot)2020-09-231-0/+26
| | | | | (cherry picked from commit 62e40d8450b9c78346ec3617de7fe3f0ad381510) Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
* bpo-35764: Rewrite the IDLE Calltips doc section (GH-22363)Miss Islington (bot)2020-09-221-22/+25
| | | Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-35293: Travis CI uses "make venv" for the doc (GH-22307) (GH-22309) ↵Victor Stinner2020-09-182-1/+13
| | | | | | | | | | | | | (GH-22310) Doc/requirements.txt becomes the reference for packages and package versions needed to build the Python documentation. * Doc/Makefile now uses Doc/requirements.txt * .travis.yml now uses "make env" of Doc/Makefile * Update Sphinx to version 2.4.4 (cherry picked from commit 8394500cca56490cc347604d39ca40abcdce46c3) (cherry picked from commit 9e73cac173e5e9010bd18c8334fffeee1cade3a4)
* bpo-35293: Remove RemovedInSphinx40Warning (GH-22198)Miss Islington (bot)2020-09-181-15/+21
| | | | | | | | | | | | | | * bpo-35293: Remove RemovedInSphinx40Warning * Update Misc/NEWS.d/next/Documentation/2020-09-12-17-37-13.bpo-35293._cOwPD.rst Co-authored-by: Victor Stinner <vstinner@python.org> * bpo-35293: Apply Victor's review Co-authored-by: Victor Stinner <vstinner@python.org> (cherry picked from commit 6595cb0af4c51c0381c233b97884fe916a4ddd35) Co-authored-by: Dong-hee Na <donghee.na92@gmail.com>
* bpo-41762: Fix usage of productionlist markup in the doc (GH-22281) (GH-22300)Miss Islington (bot)2020-09-188-69/+70
| | | | | | | | | | Use an unique identifier for the different grammars documented using the Sphinx productionlist markup. productionlist markups of the same grammar, like "expressions" or "compound statements", use the same identifier "python-grammar". (cherry picked from commit 8af239eacfcf52e4e0e2b0223e7cea4672309483) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.8] Remove duplicated words words (GH-20413). (GH-22297)Serhiy Storchaka2020-09-182-2/+2
| | | | (cherry picked from commit 1c5d1d7304a119040fd3118128bdb412f0cce6a6)
* Improve the description of difflib in the documentation (GH-22253) (GH-22260)Miss Islington (bot)2020-09-151-2/+2
| | | | | | | | | | From "can produce difference information in various formats ..." to " can produce information about file differences in various formats ..." Automerge-Triggered-By: @Mariatta (cherry picked from commit 5531269f698f789d1247123fd82681f7a455f66e) Co-authored-by: Mandeep <mandeep052@gmail.com>
* bpo-41776: Revise example of "continue" in the tutorial documentation ↵Miss Islington (bot)2020-09-151-5/+5
| | | | | | | | | | (GH-22234) (GH-22256) Revise example of "continue" in the tutorial documentation (cherry picked from commit 7bcc6456ad4704da9b287c8045768fa53961adc5) Co-authored-by: Neeraj Samtani <neerajjsamtani@gmail.com> Co-authored-by: Neeraj Samtani <neerajjsamtani@gmail.com>
* bpo-40721: add note about enum member name case (GH-22231)Miss Islington (bot)2020-09-141-0/+6
| | | | | | * UPPER_CASE preferred as enum members are constants (cherry picked from commit 542e1df2b018ee7068dba8076f2d6e84efd6e144) Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
* bpo-41778: Change a punctuation on documentation. (GH-22229) (GH-22230)Miss Islington (bot)2020-09-131-2/+2
| | | | | | | | | | | | | On this paragrapah the clarification about IIS7 seems there's not connection beacuase is in other sentence. Move the punctuation to connect both the last sentence with the information in the parenthesis. I think the NEWS is not necessary here. Automerge-Triggered-By: @ericvsmith (cherry picked from commit 94bfdee25db31941b187591ae5ae9bf3ed431090) Co-authored-by: Emmanuel Arias <eamanu@yaerobi.com>
* [3.8] bpo-37479: Enum - use correct __format__ (GH-14545)Ethan Furman2020-09-131-3/+5
| | | | | | * bpo-37479: on Enum subclasses with mixins, __format__ uses overridden __str__. (cherry picked from commit 2f19e82fbe98ce86bcd98a176328af2808b678e8) Co-authored-by: thatneat <thatneat@users.noreply.github.com>
* bpo-33239: Fix default value of 'buffering' parameter in docs of tempfile.* ↵Miss Islington (bot)2020-09-131-3/+3
| | | | | functions (GH-21763) (GH-22226) (cherry picked from commit b48389d95093c3f912549add8da339edc164bf0d)
* bpo-41672: Fix type mismatches in imaplib docs (GH-22207) (#22218)Miss Islington (bot)2020-09-121-2/+2
| | | | | | | (cherry picked from commit c75330605d4795850ec74fdc4d69aa5d92f76c00) Co-authored-by: Norbert Cyran <cyran.norbert97@gmail.com> Co-authored-by: Norbert Cyran <cyran.norbert97@gmail.com>
* [doc] struct: update note about network byte order form to be more helpful ↵Miss Islington (bot)2020-09-111-2/+4
| | | | | | | | (GH-22201) Update the sentence to provide some context on why network byte order is defined as big endian. (cherry picked from commit fb2718720346c8c7a0ad2d7477f20e9a5524ea0c) Co-authored-by: Stargirl Flowers <theaflowers@google.com>
* bpo-37149: Change Shipman tkinter link from archive.org to TkDocs (GH-22188) ↵Miss Islington (bot)2020-09-101-1/+1
| | | | | | | | | (#22193) The new link responds much faster and begins with a short explanation of the status of the doc. (cherry picked from commit 06d0b8b67e8aebd8fe4c34e97d6915c11f4afa30) Co-authored-by: Mark Roseman <mark@markroseman.com>
* [doc] Remove superfluous comment about equal in f-strings (GH-22006)Miss Islington (bot)2020-09-101-1/+1
| | | | | | Automerge-Triggered-By: @kushaldas (cherry picked from commit 788b79fa7b6184221e68d4f1a3fbe0b3270693f6) Co-authored-by: Andre Delfino <adelfino@gmail.com>