summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* closes bpo-41723: Fix an error in the py_compile documentation. (GH-22110)Miss Islington (bot)2020-09-061-1/+1
| | | | | (cherry picked from commit 5371a464ce88ffc88f3bb95cfd86f355b7d02953) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* [3.8] Improve asyncio-dev 'Concurrency and Multithreading' docs (GH-20882) ↵Miss Islington (bot)2020-09-041-0/+10
| | | | | | | | | | | | | (GH-22010) I added some information to the `Concurrency and Multithreading` section of the `Developing with asyncio` guide. This is all information that would have helped me when I started using asyncio. I incorrectly assumed that `loop.call_soon_threadsafe()` and `run_coroutine_threadsafe()` could be called from a thread in a process separate from the one that the event loop is running in. Explicitly stating that this will not work will probably help some people starting out with asyncio in the future. I also added references to some other functions that can be used for inter-process communication without blocking the event loop. The section already mentions running blocking code in a ThreadPoolExecutor, but I think listing these other options in this section will also be helpful. (cherry picked from commit c68c5af2dc5ada8875a662f2beaac6234eae2a5a) Co-authored-by: Roger Iyengar <ri@rogeriyengar.com>
* [3.8] Fix error in argparse documentation example (GH-17399) (GH-21990)Miss Islington (bot)2020-09-041-2/+2
| | | | | | | Automerge-Triggered-By: @rhettinger (cherry picked from commit 8784d3300ec4ffc58bc0e9ab3cff9a24187dbe4c) Co-authored-by: SarahPythonista <4283226+SarahPythonista@users.noreply.github.com>
* [3.8] bpo-40486: Specify what happens if directory content change diring ↵Miss Islington (bot)2020-09-043-3/+17
| | | | | | | | iteration (GH-22025) (GH-22094) (cherry picked from commit 306cfb3a37e1438f6ba9f0a9f3af3c00aae4ec64) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* bpo-38585: Remove references to defusedexpat (GH-22095)Miss Islington (bot)2020-09-041-11/+3
| | | | | | defusedexpat is not maintained. (cherry picked from commit 51b84f8e96a441c498210f827c1297ee4973525f) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-39883: Use BSD0 license for code in docs (GH-17635) (GH-22074)Miss Islington (bot)2020-09-031-0/+34
| | | | | | The PSF board approved this use. (cherry picked from commit e223d06a8b2067c68e9f97c4628c2b0f056dcae6) Co-authored-by: Todd <toddrjen@gmail.com>
* [doc] Remove references to PyChecker. (GH-22055)Miss Islington (bot)2020-09-022-14/+5
| | | | | (cherry picked from commit dea82b67315a6b873f7d4e558dd00a851137dcbb) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* Remove reference to Boa Constructor. (GH-22057)Miss Islington (bot)2020-09-021-6/+0
| | | | | (cherry picked from commit 1d25f5bf7b795b47e753aca56d7579d4ad7ee468) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* bpo-41634: Fix a typo in the curses documentation (GH-21958)Miss Islington (bot)2020-08-291-1/+1
| | | | | | (cherry picked from commit 398575c210f79627830c5c470184f54ace950ac6) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* [3.8] bpo-41624: fix documentation of typing.Coroutine (GH-21952). (#21983)Karthikeyan Singaravelan2020-08-281-1/+1
| | | | | | | (cherry picked from commit 8c58d2a216ca2b5965361df9b8d8944bc7d4854d) Co-authored-by: MingZhe Hu <humingzhework@163.com> Co-authored-by: MingZhe Hu <humingzhework@163.com>
* Document vars behavior when __dict__ is missing (GH-21466) (GH-21941)Miss Islington (bot)2020-08-221-0/+3
| | | | | (cherry picked from commit 802726acf6048338394a6a4750835c2cdd6a947b) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* Fix grammar in Doc/tutorial/controlflow.rst (GH-21885) (#21923)Miss Islington (bot)2020-08-221-1/+1
| | | | | | | Automerge-Triggered-By: @csabella (cherry picked from commit 0be7c216e16f0d459f1c8f6209734c9b2b82fbd4) Co-authored-by: Denis Ovsienko <denis@ovsienko.info>
* bpo-40994: Ungroup items in collections.abc documentation for improved ↵Miss Islington (bot)2020-08-221-5/+13
| | | | | | | | | | | clarity (GH-21880) (#21927) Use a less surprising document structure. Automerge-Triggered-By: @csabella (cherry picked from commit 2ce39631f679e14132a54dc90ce764259d26e166) Co-authored-by: Sydney Pemberton <46042811+sydneypemberton1986@users.noreply.github.com>
* bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) (GH-21901) (GH-21928)Victor Stinner2020-08-2045-246/+257
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) Enable Sphinx 3.2 "c_allow_pre_v3" option and disable the c_warn_on_allowed_pre_v3 option to make the documentation compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 423e77d6de497931585d1883805a9e3fa4096b0b) * bpo-40204: Fix Sphinx sytanx in howto/instrumentation.rst (GH-21858) Use generic '.. object::' to declare markers, rather than abusing '.. c:function::' which fails on Sphinx 3. (cherry picked from commit 43577c01a2ab49122db696e9eaec6cb31d11cc81) * bpo-40204: Fix duplicates in the documentation (GH-21857) Fix two Sphinx 3 issues: Doc/c-api/buffer.rst:304: WARNING: Duplicate C declaration, also defined in 'c-api/buffer'. Declaration is 'PyBUF_ND'. Doc/c-api/unicode.rst:1603: WARNING: Duplicate C declaration, also defined in 'c-api/unicode'. Declaration is 'PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)'. (cherry picked from commit 46d10b1237c67ff8347f533eda6a5468d098f7eb) * bpo-40204: Add :noindex: in the documentation (GH-21859) Add :noindex: to duplicated documentation to fix "duplicate object description" errors. For example, fix this Sphinx 3 issue: Doc/library/configparser.rst:1146: WARNING: duplicate object description of configparser.ConfigParser.optionxform, other instance in library/configparser, use :noindex: for one of them (cherry picked from commit d3ded080482beae578faa704b13534a62d066f9f) * bpo-40204, doc: Fix syntax of C variables (GH-21846) For example, fix the following Sphinx 3 errors: Doc/c-api/buffer.rst:102: WARNING: Error in declarator or parameters Invalid C declaration: Expected identifier in nested name. [error at 5] void \*obj -----^ Doc/c-api/arg.rst:130: WARNING: Unparseable C cross-reference: 'PyObject*' Invalid C declaration: Expected end of definition. [error at 8] PyObject* --------^ The modified documentation is compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 474652fe9346382dbf793f20b671eb74668bebde) * bpo-40204: Fix reference to terms in the doc (GH-21865) Sphinx 3 requires to refer to terms with the exact case. For example, fix the Sphinx 3 warning: Doc/library/pkgutil.rst:71: WARNING: term Loader not found in case sensitive match.made a reference to loader instead. (cherry picked from commit bb0b08540cc93e56f3f1bde1b39ce086d9e35fe1) * bpo-40204: Fix duplicated productionlist names in the doc (GH-21900) Sphinx 3 disallows having more than one productionlist markup with the same name. Simply remove names in this case, since names are not shown anyway. For example, fix the Sphinx 3 warning: Doc/reference/introduction.rst:96: duplicate token description of *:name, other instance in reference/expressions (cherry picked from commit 1abeda80f760134b4233608e2c288790f955b95a) (cherry picked from commit 8f88190af529543c84d5dc78f19abbfd73335cf4)
* Fix typo in typing doc (GH-21879)Miss Islington (bot)2020-08-141-1/+1
| | | | | | Automerge-Triggered-By: @gvanrossum (cherry picked from commit fa5d7251987c70a9c5d58b59a0b36ac9287eaafa) Co-authored-by: Irit Katriel <iritkatriel@yahoo.com>
* bpo-41410: Fix outdated info in mkstemp docs (GH-21701)Miss Islington (bot)2020-08-141-3/+2
| | | | | | Automerge-Triggered-By: @ericvsmith (cherry picked from commit e55de68be3e5b977a17d3c0ac9805b0feff8fedc) Co-authored-by: Rishav Kundu <rk@rishav.io>
* Fixed comment about pathlib.link_to: it was added in 3.8, not changed. ↵Miss Islington (bot)2020-08-131-1/+1
| | | | | | | (GH-21851) (#21866) (cherry picked from commit a3eae43aeedb6e6a31adeab3c0c90961d05ab113) Co-authored-by: Facundo Batista <facundo@taniquetil.com.ar>
* [3.8] bpo-41066: Update the comparison section for os vs pathlib (GH-21261) ↵Antoine Pitrou2020-08-131-0/+3
| | | | | | | | | (GH-21864) (cherry picked from commit 0eb9deb4a62e6d9daa82bc2f67d1075864ca8ece) Co-authored-by: Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి) <thatiparthysreenivas@gmail.com> Automerge-Triggered-By: @pitrou
* bpo-41475: Fix note in "What's new in 3.7" (GH-21733) (GH-21833)Miss Islington (bot)2020-08-121-1/+1
| | | | | (cherry picked from commit 76643c10ede2813ca921464fe839e81caee21a84) Co-authored-by: Ram Rachum <ram@rachum.com>
* [3.8] bpo-41504: Add links to asttokens, leoAst, LibCST and parso to ast ↵Miss Islington (bot)2020-08-111-2/+21
| | | | | | | | | docs (GH-21773) (GH-21829) (cherry picked from commit e3c971ccfa58afcb2656b71b95e10b9703f2ad32) Co-authored-by: Edward K. Ream <edreamleo@gmail.com> https://bugs.python.org/issue41504
* [3.8] Doc: Add output to example code in programming FAQ (GH-21346) (GH-21791)Miss Islington (bot)2020-08-091-34/+37
| | | | | | | | | | | Add output hint to document, part faq/programming, section [How do I write a function with output parameters (call by reference)?](https://docs.python.org/3/faq/programming.htmlGH-how-do-i-write-a-function-with-output-parameters-call-by-reference). This patch make the output hint just like prefix code block. (cherry picked from commit 67acf74c4eaf64a860cc1bcda6efe6e9cb01f89b) Co-authored-by: Jiajie Zhong <zhongjiajie955@hotmail.com> Automerge-Triggered-By: @merwok
* bpo-41455: Provide a link to how the third generation is collected in the GC ↵Miss Islington (bot)2020-08-081-3/+3
| | | | | | | | docs (GH-21703) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com> (cherry picked from commit 82ca8fada15b121866530f2cdac1b7055be4a244) Co-authored-by: Yaroslav Pankovych <31005942+P-Alban@users.noreply.github.com>
* Doc: Add a link to tutorial page from `open()` doc (GH-21737)Miss Islington (bot)2020-08-081-1/+2
| | | | | | | | Adds a link to the "Reading and Writing Files" page so users can more easily discover how file handles are handled with the `with` context manager vs without it. (cherry picked from commit 705f14556545699ab615ec98f707b438f9603767) Co-authored-by: Benjamin Kane <bbkane@users.noreply.github.com>
* bpo-41098: Doc: Add missing deprecated directives (GH-21162)Miss Islington (bot)2020-08-071-0/+10
| | | | | | | PyUnicodeEncodeError_Create has been deprecated with `Py_DEPRECATED` macro. But it was not documented. (cherry picked from commit 46e19b61d31ba99f049258efa4ff1334856a3643) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* bpo-36346: Doc: Update removal schedule of legacy Unicode (GH-21479)Miss Islington (bot)2020-08-051-9/+30
| | | | | | See PEP 623 for detail. (cherry picked from commit 270b4ad4df795783d417ba15080da8f95e598689) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* bpo-41425: Make tkinter doc example runnable (GH-21706)Miss Islington (bot)2020-08-031-12/+16
| | | | | | Co-authored-by: Ankit Chandawala <achandaw@amazon.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> (cherry picked from commit c36dbac588e1d99975f285a874bb20e9f5040af4)
* bpo-41424: Remove extra words in Tkinter-Packer documentation (GH-21707)Miss Islington (bot)2020-08-031-6/+5
| | | | | (cherry picked from commit ecaf949cc487887883c14dff7a96e09ac9404994) Co-authored-by: Nathan M <nathanmaynes@gmail.com>
* bpo-41426 Fix grammar in curses.getmouse() documentation (GH-21677)Miss Islington (bot)2020-07-291-1/+1
| | | | | | Automerge-Triggered-By: @brettcannon (cherry picked from commit ba18c0b13ba3c08077ea3db6658328523823a33f) Co-authored-by: Sebastien Williams-Wynn <s.williamswynn.mail@gmail.com>
* Remove incorrect mention of method.__class__ in descriptor docs (GH-21665) ↵Miss Islington (bot)2020-07-291-4/+2
| | | | (GH-21668)
* Fix `List_Append` description, list is extracted at TOS1[-i] (GH-21465)Miss Islington (bot)2020-07-281-1/+1
| | | | | (cherry picked from commit 34cd3e9f6a87f9c50edac893b0d5ae46c4e48ee3) Co-authored-by: Xiang Zhang <angwerzx@126.com>
* bpo-41328: Replace mention of Hudson CI with Travis CI and AppVeyor (GH-21653)Miss Islington (bot)2020-07-281-1/+1
| | | | | (cherry picked from commit 5e3826785dcc64f8e1a8a7bde11b88fbb40943be) Co-authored-by: Dmytro Litvinov <litvinov.dmytro.it@gmail.com>
* [3.8] bpo-41045: Document debug feature of f-strings ('=') (GH-21509) (#21647)Guido van Rossum2020-07-271-5/+32
| | | | | | | Co-Authored-By: Rishi <rishi93dev@gmail.com> (cherry picked from commit 13efaec) Co-authored-by: amaajemyfren <32741226+amaajemyfren@users.noreply.github.com>
* bpo-39868: Add documentation for Assignment Expressions (walrus, PEP 572) ↵Miss Islington (bot)2020-07-251-2/+19
| | | | | | | (GH-18851) (cherry picked from commit f117cef25b5ffc4db9fbe373ddb65e14f59f0397) Co-authored-by: Shankar Jha <shankarj67@gmail.com>
* bpo-41314: fixed annotations __future__ version (GH-21616)Miss Islington (bot)2020-07-251-1/+1
| | | | | | PEP 563 was updated to change the release where `from __future__ import annotations` becomes the default (and only) behavior from 4.0 to 3.10. Update `__future__.py` and its docs to reflect this. (cherry picked from commit 0028c14073109595e7532ec00bb1e8bf39ecfb4d) Co-authored-by: YoSTEALTH <35307184+YoSTEALTH@users.noreply.github.com>
* 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-32528: Document the change in inheritance of asyncio.CancelledError ↵Miss Islington (bot)2020-07-191-2/+4
| | | | | | | | | | | | (GH-21474) GH-msg373510 [bpo-32528]()/GH-13528 changed `asyncio.CancelledError` such that it no longer inherits from `concurrent.futures.CancelledError`. As this affects existing code, specifically when catching the latter instead of the former in exception handling, it should be documented in the "What's new in 3.8?" document. Automerge-Triggered-By: @1st1 (cherry picked from commit 2a5181829af394b82e8e8c917183c709ee72a2b7) Co-authored-by: JustAnotherArchivist <JustAnotherArchivist@users.noreply.github.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>
* Fix repeated words in Classes tutorial (GH-21455)Miss Islington (bot)2020-07-141-2/+2
| | | | | | | | The phrase "At any time during execution," was repeated twice. Automerge-Triggered-By: @Mariatta (cherry picked from commit 4f28f75deefc6e8f65694f96f1a40b0a26fc385d) Co-authored-by: Paul McMillan <paul@mcmillan.ws>
* 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-28681: Clarify multiple function names in the tutorial (GH-21340) (GH-21344)Miss Islington (bot)2020-07-061-5/+4
| | | | | | | | | | | | | | * improve control flow docs * Add also Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> (cherry picked from commit d12af71047f0eae86440654d3ea74c032c7c3558) Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com> Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
* bpo-26205: Specify the number of nested scopes (GH-21324) (GH-21342)Miss Islington (bot)2020-07-061-2/+2
| | | | | | | | | | | | | | * Clarify number of scopes * Indicate 3 or 4 Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> (cherry picked from commit 9ed3cd8ba052b395ab50692bb65988b065d68e27) Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com> Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
* bpo-41211: Doc: Fix PyLong_FromUnicode (GH-21331)Miss Islington (bot)2020-07-051-3/+1
| | | | | | PyUnicode_EncodeDecimal is not used actually. (cherry picked from commit 16f451744b7f4653ca9db4b4bedbb6fc5c0de154) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* bpo-41211: Doc: Fix PyLong_FromUnicodeObject (GH-21325)Miss Islington (bot)2020-07-051-3/+1
| | | | | | It doesn't use PyUnicode_EncodeDecimal. It uses a private API instead. (cherry picked from commit 9c8441712230660fedac818ed50e7cdd89e4c51d) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
generated by cgit v0.12 at 2026-02-12 16:19:07 (GMT)