summaryrefslogtreecommitdiffstats
path: root/Doc/library
Commit message (Collapse)AuthorAgeFilesLines
* Simple Documentation fix: Missing link to return type class. (GH-21291)Miss Islington (bot)2020-07-201-2/+4
| | | | | | Just a simple documentation fix: apply_async and map_async return a "multiprocessing.pool.AsyncResult Object", not a "result object". (cherry picked from commit f9bf0157999cb4adbcfd7e9bf526bfa48601e128) Co-authored-by: Volker-Weissmann <39418860+Volker-Weissmann@users.noreply.github.com>
* bpo-37703: improve asyncio.gather documentation regarding cancellation ↵Miss Islington (bot)2020-07-201-0/+8
| | | | | | | | | | (GH-15312) These changes updates the doc to comprehensively mention the behaviour of gather.cancel() Automerge-Triggered-By: @asvetlov (cherry picked from commit d42528a3a2c7d79fd2e6c9f2a02f3ce12d44c8cc) Co-authored-by: Vinay Sharma <vinay04sharma@icloud.com>
* bpo-41205: Document Decimal power 0 to the 0 (GH-21386)Miss Islington (bot)2020-07-191-0/+3
| | | | | | Co-authored-by: Mark Dickinson <dickinsm@gmail.com> (cherry picked from commit 10e466448f67850ed7bb2e2a4e7f017f2b050cad) Co-authored-by: Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి) <thatiparthysreenivas@gmail.com>
* bpo-41325: Add version note for args and kwargs property in call object ↵Miss Islington (bot)2020-07-181-0/+3
| | | | | | | (GH-21525) (cherry picked from commit 9b01c598ca2576a1056816e85dd84bf5f9c74688) Co-authored-by: Jordan Speicher <uSpike@users.noreply.github.com>
* Remove unnecessary spaces in code blocks in urllib.parse.rst (GH-21500)Miss Islington (bot)2020-07-161-15/+15
| | | | | | | | This should also fix the syntax highlighting for these code blocks Automerge-Triggered-By: @csabella (cherry picked from commit 5e5c0f98667c9280c6d27b3db98a6cad2cc89077) Co-authored-by: Christopher Yeh <chrisyeh96@users.noreply.github.com>
* bpo-41228: Fix /a/are/ in monthcalendar() descripton (GH-21372)Miss Islington (bot)2020-07-111-1/+1
| | | | | (cherry picked from commit 344dce312a0cf86d5a5772d54843cc179acaf6e3) Co-authored-by: Nima Dini <nima.dini@gmail.com>
* Fix typo in docs: 'created by th' -> 'created by the' (GH-21384)Miss Islington (bot)2020-07-101-1/+1
| | | | | (cherry picked from commit 6fc732a2116e2c42b0431bb7e2a21719351af755) Co-authored-by: marload <rladhkstn8@gmail.com>
* bpo-37765: Add keywords to IDLE tab completions (GH-15138)Miss Islington (bot)2020-07-091-42/+48
| | | | | | | | | | Keywords are present in the main module tab completion lists generated by rlcompleter, which is used by REPLs on *nix. Add all keywords to IDLE's main module name list except those already added from builtins (True, False, and None) . This list may also be used by Show Completions on the Edit menu, and its hot key. Rewrite Completions doc. Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com> (cherry picked from commit bce2eb4646021910aa4074d86f44a09b32d0b2b2) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-41199: Docstring convention not followed for dataclasses documentation ↵Miss Islington (bot)2020-07-091-1/+1
| | | | | | | | page (GH-21413) Automerge-Triggered-By: @ericvsmith (cherry picked from commit 61bb24a270d15106decb1c7983bf4c2831671a75) Co-authored-by: marload <rladhkstn8@gmail.com>
* bpo-39417: Fix broken link to guide to building venvs (GH-18432)Miss Islington (bot)2020-07-071-1/+1
| | | | | (cherry picked from commit c4a65ed7fe342bd18b5a5b0eea3470dc4fc31160) Co-authored-by: Ogi Moore <ognyan.moore@jacobs.ucsd.edu>
* bpo-33864: Clarify the docs for typing.ByteString (GH-21311)Miss Islington (bot)2020-07-041-1/+1
| | | | | (cherry picked from commit b40e434386cd94a367d4a256e3364771140160e7) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* Update ssl.rstMiss Islington (bot)2020-06-291-0/+3
|
* bpo-40773: Fix rendering for 'retval' on the pdb page (GH-21081)Miss Islington (bot)2020-06-241-0/+1
| | | | | | Automerge-Triggered-By: @merwok (cherry picked from commit cf18c9e9d4d44f6671a3fe6011bb53d8ee9bd92b) Co-authored-by: Arisaka97 <solitaire2312@gmail.com>
* bpo-40707: Document that Popen.communicate sets the returncode attribute ↵Miss Islington (bot)2020-06-241-4/+5
| | | | | | | (GH-20283) (cherry picked from commit bf2e515fa43406d4bd9c4c53ecc9364034d8f9f6) Co-authored-by: Gareth Rees <gdr@garethrees.org>
* Improve asyncio.loop.call_soon() documentation (GH-20883)Miss Islington (bot)2020-06-232-3/+3
| | | | | | | | | * Add a glossary entry for the term "callback" * Link to it in loop.call_soon() and in the "Concurrency and Multithreading" section Co-authored-by: Kyle Stanley <aeros167@gmail.com> (cherry picked from commit a16d6970496cae5ecab5aaea2b416a4b77527cc2) Co-authored-by: Roger Iyengar <ri@rogeriyengar.com>
* [3.8] bpo-37674: Tweak imp module deprecation note in the docs (GH-20480) ↵Miss Islington (bot)2020-06-131-1/+1
| | | | | | | | | | (GH-20860) (cherry picked from commit dea3223740127ac13f984c1d38f127ab6701af44) Co-authored-by: Zackery Spytz <zspytz@gmail.com> Automerge-Triggered-By: @brettcannon
* [3.8] bpo-40895: Update weakref documentation to remove old warnings ↵Antoine Pitrou2020-06-101-14/+0
| | | | | | | | | | | | | | | | | (GH-20687) (GH-20792) The doccumentation at https://docs.python.org/3.10/library/weakref.html cautions that the `WeakKeyDictionary` and `WeakValueDictionary` are susceptible to the problem of dictionary mutation during iteration. These notes present the user with a problem that has no easy solution. I dug into the implementation and found that fortunately, Antoine Pitrou already addressed this challenge (10 years ago!) by introducing an `_IterationGuard` context manager to the implementation, which delays mutation while an iteration is in progress. I asked for confirmation and @pitrou agreed that these notes could be removed: https://github.com/python/cpython/commit/c1baa601e2b558deb690edfdf334fceee3b03327GH-commitcomment-39514438. (cherry picked from commit 1642c0ef750f96664a98cadb09301d492098d2fb) Co-authored-by: Daniel Fortunov <asqui@users.noreply.github.com> Automerge-Triggered-By: @pitrou
* [3.8] bpo-34003: Re-add versionchanged entry in csv docs (GH-20657) (GH-20771)Miss Islington (bot)2020-06-101-0/+3
| | | | | | | | | Follow-up to GH-8014 (cherry picked from commit 7aed0524d4129766a6032326949ef7f91f6f6dfc) Co-authored-by: Éric Araujo <merwok@netwok.org> Automerge-Triggered-By: @merwok
* [3.8] Revert bpo-39576: docs: set context for decimal arbitrary precision ↵Stefan Krah2020-06-081-58/+8
| | | | | arithmetic (GH-20745) This reverts commit d6965ff026f35498e554bc964ef2be8f4d80eb7f.
* [3.8] Revert bpo-39576: Clarify the word size for the 32-bit build. (GH-20743)Stefan Krah2020-06-081-2/+2
| | | This reverts commit c6ecd9c14081a787959e13df33e250102a658154.
* bpo-22021: Update root_dir and base_dir documentation in shutil (GH-10367)Miss Islington (bot)2020-06-081-3/+47
| | | | | | | | Also added an example in shutil in order to make more clear how they are to be used. Initially reported by Weinan Li on bpo. (cherry picked from commit 7633371dace67aaa21eb4b86f889441571ec4167) Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
* Fix spacing in docs for tarfile (GH-20629)Miss Islington (bot)2020-06-041-1/+1
| | | | | | | | | | | | | | | | | | | | Before ``` content.txt is 42 bytes in size and isa regular file. folder is 420 bytes in size and isa directory. magic is 4200 bytes in size and issomething else. ``` After: ``` content.txt is 42 bytes in size and is a regular file. folder is 420 bytes in size and is a directory. magic is 4200 bytes in size and is something else. ``` Automerge-Triggered-By: @orsenthil (cherry picked from commit 7a280197f4162e5fcdde6f34701a9fa6e669190d) Co-authored-by: Harsha Laxman <HarshaLaxman@users.noreply.github.com>
* closes bpo-29017: Update the bindings for Qt information with PySide2 (GH-20149)Miss Islington (bot)2020-05-301-5/+6
| | | | | | Reference to PySide has been removed has it is for Qt 4, which has reached end of life. (cherry picked from commit 4649202ea75d48e1496e99911709824ca2d3170e) Co-authored-by: Samuel Gaist <samuel.gaist@idiap.ch>
* Note the output ordering of combinatoric functions (GH-19732) (GH-20502)Miss Islington (bot)2020-05-281-9/+9
|
* bpo-40025: Require _generate_next_value_ to be defined before members(GH-19763)Miss Islington (bot)2020-05-271-0/+4
| | | require `_generate_next_value_` to be defined before members
* [3.8] bpo-38580: Document that select() accepts iterables, not just ↵Tal Einat2020-05-261-3/+3
| | | | | | | sequences (GH-16832) (cherry picked from commit 372ee27d4958302dac7ad6a8711f6fd04771b2e6) Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
* bpo-39301: State that floor division is used for right shift operations ↵Miss Islington (bot)2020-05-261-4/+2
| | | | | | | | | | | (GH-20347) (GH-20415) * bpo-39301: State that floor division is used for right shift operations * Remove "without overflow check" (cherry picked from commit af7553ac95a96713be847dd45bc5a8aeb0a75955) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-40745: Fix typos in NewType docs (GH-20379)Miss Islington (bot)2020-05-261-2/+2
| | | | | (cherry picked from commit 2b0e654f91f28379c6c7ef5fd80e8754afb70935) Co-authored-by: ziheng <zihenglv@gmail.com>
* closes bpo-40774: Fix docs indentation for asyncio.create_subprocess_shell() ↵Miss Islington (bot)2020-05-261-8/+8
| | | | | | | (GH-20403) (cherry picked from commit 4a0ac42c52a4d9ccfb0a78ab02aa03172ce0e31a) Co-authored-by: sth <sth.dev@tejp.de>
* bpo-40405: Fix asyncio.as_completed docs (GH-19753)Miss Islington (bot)2020-05-231-5/+5
| | | | | | | | | | | * Fix as_completed docs to correctly state the function return value. * Also, improves the general wording of the as_completed documentation. Co-Authored-By: Rémi Lapeyre <remi.lapeyre@henki.fr> Co-Authored-By: Kyle Stanley <aeros167@gmail.com> Co-Authored-By: Yury Selivanov <yury@edgedb.com> (cherry picked from commit 13206b52d16c2489f4c7dd2dce2a7f48a554b5ed) Co-authored-by: Bar Harel <bzvi7919@gmail.com>
* Reword aware/naive introduction sentence (GH-20175)Miss Islington (bot)2020-05-221-1/+2
| | | | | | | | This is more informative and avoids the question of whether the period should go inside or outside the quotation marks. See also GH-20007. (cherry picked from commit 2e76820a50b8ce2a9a5f6cdef6cef1859a89c460) Co-authored-by: Mathieu Dupuy <mathieu.dupuy@doctolib.com>
* bpo-40651: Improve LRU recipe in the OrderedDict documentation ↵Miss Islington (bot)2020-05-211-0/+2
| | | | (GH-GH-20139) (GH-20167)
* bpo-39976: Add **other_popen_kwargs to subprocess docs (GH-20145)Miss Islington (bot)2020-05-191-4/+8
| | | | | (cherry picked from commit 46545000c2a30b46aed717b546bc09e5bae7148f) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* Doc: change 'Posix' for 'POSIX' (GH-20001)Miss Islington (bot)2020-05-172-5/+5
| | | | | (cherry picked from commit 65460565df99fbda6a74b6bb4bf99affaaf8bd95) Co-authored-by: Mathieu Dupuy <mathieu.dupuy@doctolib.com>
* Doc: move a dot outside double quotes (GH-20007)Miss Islington (bot)2020-05-171-1/+1
| | | | | (cherry picked from commit 4eba67783eb2084b2dad875ed1cbffdaf8a9202e) Co-authored-by: Mathieu Dupuy <mathieu.dupuy@doctolib.com>
* bpo-38872: Document exec symbol for codeop.compile_command (GH-20047) (GH-20098)Miss Islington (bot)2020-05-152-4/+5
| | | | | | | | | | | | * Document exec symbol for codeop.compile_command * Remove extra statements Co-authored-by: nanjekyejoannah <joannah.nanjekye@ibm.com> (cherry picked from commit 7ba1f75f3f02b4b50ac6d7e17d15e467afa36aac) Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com> Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
* Make the first dataclass example more useful (GH-19994) (GH-19997)Miss Islington (bot)2020-05-081-0/+2
| | | | | | | (cherry picked from commit 2effef7453986bf43a6d921cd471a8bc0722c36a) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* Remove outdated and confusing advice about setting maxsize (GH-19889) (GH-19890)Miss Islington (bot)2020-05-041-2/+1
|
* Fix missing space in docs(GH-19866) (GH-19872)Miss Islington (bot)2020-05-031-1/+1
|
* bpo-40419: timeit CLI docs now mention 1,2,5,10,... trials instead of powers ↵Miss Islington (bot)2020-05-021-1/+2
| | | | | | | of 10 (GH-19752) (cherry picked from commit 766352320fd736e2c8ed545b4cc57563f61a0b9d) Co-authored-by: Sander <svr003@gmail.com>
* [3.8] bpo-39435: Fix docs for pickle.loads (GH-18160) (GH-19843)Antoine Pitrou2020-05-011-2/+2
| | | | | | | (cherry picked from commit 289842a) Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com> Automerge-Triggered-By: @pitrou
* bpo-39691: Clarify io.open_code behavior (GH-19824)Miss Islington (bot)2020-05-011-4/+5
| | | | | (cherry picked from commit 831d58d7865cb98fa09227dc614f4f3ce6af968b) Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com>
* bpo-40387: Improve queue join() example. (GH-19724) (GH-19726)Miss Islington (bot)2020-04-271-16/+12
|
* Minor modernization and readability improvement to the tokenizer example ↵Miss Islington (bot)2020-04-221-2/+6
| | | | | (GH-19558) (GH-19661) (cherry picked from commit bf1a81258c0ecc8b52b9dcc53321c066b3ed4a67)
* Small improvements to the recipes and examples. (GH-19635) (GH-19638)Miss Islington (bot)2020-04-211-30/+26
| | | | | | | * Add underscores to long numbers to improve readability * Use bigger dataset in the bootstrapping example * Convert single-server queue example to more useful multi-server queue (cherry picked from commit d3a8d616faf3364b22fde18dce8c168de9368146)
* bpo-39285: Clarify example for PurePath.match (GH-19458)Miss Islington (bot)2020-04-191-1/+3
| | | | | | | | | | | | | | Fixes Issue39285 The example incorrectly returned True for match. Furthermore the example is ambiguous in its usage of PureWindowsPath. Windows is case-insensitve, however the underlying match functionality utilizes fnmatch.fnmatchcase. Automerge-Triggered-By: @pitrou (cherry picked from commit c12375aa0b838d34067efa3f1b9a1fbc632d0413) Co-authored-by: Tim Lo <timlo@users.noreply.github.com>
* bpo-27635: Fix pickle documentation about `__new__` not being called. (GH-19269)Miss Islington (bot)2020-04-181-3/+3
| | | | | | Automerge-Triggered-By: @pitrou (cherry picked from commit 482259d0dcf27714a84cf56b93977320bea7e093) Co-authored-by: Furkan Önder <furkantahaonder@gmail.com>
* Fix parameter names in assertIn() docs (GH-18829)Miss Islington (bot)2020-04-171-3/+3
| | | | | | The names "member" and "container" for the arguments are also used in the module and shown with the help() function, and are immediately understandable in this context, contrary to "first" and "second". (cherry picked from commit a388bbd3f129364c39843f63e92f08bc53c71905) Co-authored-by: Christoph Zwerschke <cito@online.de>
* [3.8] bpo-39667: Sync zipp 3.0 (GH-18540) (GH-18701)Miss Islington (bot)2020-04-151-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | * bpo-39667: Sync zipp 3.0 (GH-18540) * bpo-39667: Improve pathlib.Path compatibility on zipfile.Path and correct performance degradation as found in zipp 3.0 * 📜🤖 Added by blurb_it. * Update docs for new zipfile.Path.open * Rely on dict, faster than OrderedDict. * Syntax edits on docs Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> (cherry picked from commit 0aeab5c4381f0cc11479362af2533b3a391312ac) Co-authored-by: Jason R. Coombs <jaraco@jaraco.com> * Clarify the change in behavior with a couple of workaround options. * Restore API compatibility while backporting performance improvements. Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
* [3.8] Improved documentation for `BUILD_CONST_KEY_MAP` (GH-19454) (GH-19495)Miss Islington (bot)2020-04-131-3/+3
| | | | | | | | (cherry picked from commit 85dd6bb1f61f7edcd6ac0b640a98644531690a0e) Co-authored-by: laike9m <laike9m@users.noreply.github.com> Automerge-Triggered-By: @zhangyangyu