summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
...
* gh-51511: Note that codecs.open()'s encoding parameter affects automatic ↵Miss Islington (bot)2022-10-211-1/+2
| | | | | | | conversion to binary mode (GH-94370) (cherry picked from commit d9407b174c81fda33e6c09a6f988c9a7cb8368af) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* [3.10] [doc] Improve logging cookbook example. (GH-98481) (GH-98482)Miss Islington (bot)2022-10-201-0/+65
| | | Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
* [3.10] [doc] Refresh the venv introduction documentation, and correct… ↵Vinay Sajip2022-10-192-101/+134
| | | | | | (GH-98466) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Phil Elson <pelson.pub@gmail.com>
* Doc: Remove title text from internal links (GH-98409)Miss Islington (bot)2022-10-191-5/+3
| | | | | | Rely on the title of the linked internal page instead of putting the title. Sphinx will render with the title correctly, and this will reduce work for translators (cherry picked from commit 52fcba651288ac1c0f9b1fb71379f1dad54ee1da) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* [3.10] Docs: Fix backtick errors found by sphinx-lint (GH-97998) (#98373)C.A.M. Gerlach2022-10-1749-89/+81
| | | | | | | | Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>. (cherry picked from commit fa2d43e5184f5eaf3391844ec2400342a1b2ead4) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-85299: Add note warning about entry point guard for asyncio example ↵Miss Islington (bot)2022-10-162-1/+9
| | | | | | | (GH-93457) (cherry picked from commit 79fd6ccdbe00ec95e4d33fc24fe76076282a334e) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* [3.10] docs(typing): harmonize "See PEP x for more details" (GH-97927). (#98293)Jelle Zijlstra2022-10-161-6/+5
| | | | | (cherry picked from commit 02389658a4751a0166e2ed22be112b646378a01b) Co-authored-by: Simon Legner <Simon.Legner@gmail.com>
* [3.10] [doc] Update logging cookbook with an example of custom handli… ↵Vinay Sajip2022-10-151-2/+283
| | | | | (GH-98299) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* gh-96265: Formatting changes for faq/general (GH-98129)Miss Islington (bot)2022-10-121-12/+18
| | | | | | | | | | | | | | | | | | | | | | | * Some formatting changes for general faq * Use list for Python versioning Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> * New line for list, list for a/b/rc * Line wrap for 80 chars * More line wrap * Remove PythonWin mention. Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> (cherry picked from commit e9569ec43e2376aa77240cd630db4be07e8720f3) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* tutorial: remove "with single quotes" (GH-98204)Miss Islington (bot)2022-10-121-1/+1
| | | | | | | | | Closes GH-91856. On Windows double quotes are sometimes better, on Unix usually single quotes. It's not our place to explain that, so just don't. (cherry picked from commit 5f8ca1b7969f34ee09adb7b28337ebd920e6215a) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* gh-65046: Link to logging cookbook from asyncio docs (GH-98207)Miss Islington (bot)2022-10-122-1/+4
| | | | | (cherry picked from commit c39a0c335486fa8eac0f3030930f9e8769118a4f) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* Formatting fixes in contextlib docs (GH-98111)Miss Islington (bot)2022-10-121-11/+17
| | | | | (cherry picked from commit 3b33c2010aa00ef5877bc35b02ae658e3c9f27af) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* gh-95276: Add callable entry to the glossary (GH-95738)Miss Islington (bot)2022-10-121-0/+10
| | | | | (cherry picked from commit e3bf125c81d5da0734429c1cb6ae75e6086e35ae) Co-authored-by: MonadChains <monadchains@gmail.com>
* gh-96130: Rephrase use of "typecheck" verb for clarity (GH-98144)Miss Islington (bot)2022-10-121-10/+10
| | | | | | | I'm sympathetic to the issue report, especially in case this helps clarify to new users that Python itself does not do type checking at runtime (cherry picked from commit ed6344eed043eaaa41d11c1176c25aa79de64ef4) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* [3.10] gh-88452: Add a warning about non-portability of environments. ↵Miss Islington (bot)2022-10-101-0/+13
| | | | (GH-98155) (GH-98156)
* gh-83940: os docs: Improve wording for getenv/getenvb (GH-98113)Miss Islington (bot)2022-10-101-4/+4
| | | | | (cherry picked from commit 187e853690908ca2af19a0701ca7529b43d05df9) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* doc: remove a misleading statement. (GH-98093)Miss Islington (bot)2022-10-101-2/+2
| | | | | (cherry picked from commit 571e23d99157ed7ad67ca2334a396fc9ddbe07ec) Co-authored-by: Julien Palard <julien@palard.fr>
* gh-56133: copyreg docs: Clarify function/constructor parameter (GH-95497)Miss Islington (bot)2022-10-101-9/+6
| | | | | (cherry picked from commit 281a3f18cc2afac0fa92c75e807775971e531711) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* Fix types in buffer/memoryview docs (GH-98118)Miss Islington (bot)2022-10-102-2/+2
| | | | | | | | | | | The definition of obj in the `Py_buffer` struct is as a PyObject* https://github.com/python/cpython/blob/ec091bd47e2f968b0d1631b9a8104283a7beeb1b/Include/pybuffer.hGH-L22 PyMemoryView_GET_BASE returns `.obj` - thus its return type should be a PyObject* (or at least a void*). It definitely doesn't return `Py_buffer` (cherry picked from commit c459fedf7cfd5dadf72e088d789c7375b3a6e093) Co-authored-by: da-woods <dw-git@d-woods.co.uk>
* [3.10] Minor edits to the Descriptor HowTo Guide (GH-24901) (GH-98114)Miss Islington (bot)2022-10-091-6/+8
|
* gh-97913 Docs: Add walrus operator to the index (GH-97921)Miss Islington (bot)2022-10-081-0/+6
| | | | | | | | | | | | | | | | | * Add walrus operator to the index * Add named expression to the index Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com> * Fix indentation and add missing newline Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> (cherry picked from commit 296313002fde56f52d6c81f17d7ba5c2eb57d098) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-97822: Fix http.server documentation reference to test() function (GH-98027)Miss Islington (bot)2022-10-081-2/+2
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 6b485629d2e3e232460db7da3f8b18b67d4f4da8) Co-authored-by: JasonYZ <yurenzhang2017@gmail.com>
* gh-57179: Add note on symlinks for os.walk (GH-94799)Miss Islington (bot)2022-10-081-1/+2
| | | | | (cherry picked from commit 0f498f1a95306995ca1e287f552c5c3d856be02d) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* gh-61105: Add default param, note on using cookiejar subclass (GH-95427)Miss Islington (bot)2022-10-081-3/+5
| | | | | (cherry picked from commit 5eaf4d610147a3b9adc91a55790096d05bbe01d4) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* [3.10] gh-91708: Revert params note in urllib.parse.urlparse table ↵Miss Islington (bot)2022-10-071-1/+2
| | | | | | | | (GH-96699) (#98053) Revert params note in urllib.parse.urlparse table (cherry picked from commit eed80458e8e776d15fa862da71dcce58c47e2ca7) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* Add a warning message about PyOS_snprintf (GH-95993)Miss Islington (bot)2022-10-071-1/+2
| | | | | (cherry picked from commit c7b220499662f0c7a4cae51e33372f92ca7b1ee9) Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
* gh-65496: Correct wording on csv's skipinitialspace argument (GH-96170)Miss Islington (bot)2022-10-071-1/+1
| | | | | (cherry picked from commit 676d8ef3806758bcd1d3fd84a746c8a9b64480d0) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* [3.10] gh-96959: Update HTTP links which are redirected to HTTPS (GH-98039) ↵Miss Islington (bot)2022-10-072-2/+2
| | | | | | | (#98050) (cherry picked from commit c81c64ca58822156beba79dfd3035bf2a5b7354e) Co-authored-by: 180909 <734461790@qq.com>
* gh-64921: Clarify wording for open()'s newline arg (GH-96171)Miss Islington (bot)2022-10-071-2/+2
| | | | | (cherry picked from commit 4a74e6ab3885e7906cc5e0b15addc7779bc76249) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* [3.10] gh-71316: Update dis documentation to include changes to jump ↵Christopher Chianelli2022-10-071-0/+4
| | | | | | | arguments (GH-95798). (GH-98029) (cherry picked from commit 6592a62ec2939323b895c85780da7fd73a640da3) Co-authored-by: Christopher Chianelli <cchianel@redhat.com>
* [3.10] Remove extra spaces in custom openSSL documentation. (GH-93568) (#98008)Miss Islington (bot)2022-10-071-10/+10
| | | | | | | | Remove extra spaces in custom openSSL documentation. (GH-93568) (cherry picked from commit 4875433682ffec2694647ac43f1b21f5ad73fd25) Co-authored-by: Xiao Chen <chenxiao_7@163.com> Co-authored-by: Xiao Chen <chenxiao_7@163.com>
* gh-97850: Remove the open issues section from the import reference (GH-97935)Miss Islington (bot)2022-10-061-19/+0
| | | | | | | | Remove the open issues section from the import reference Tracking in https://github.com/python/cpython/issues/97850 instead. (cherry picked from commit f8edc6ff531bb98858185857513371f14519ed1d) Co-authored-by: Brett Cannon <brett@python.org>
* gh-86482: Document assignment expression need for ()s (GH-23291)Miss Islington (bot)2022-10-061-0/+7
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 2b5f1360ead9aa72ae00de59edfd6c229d13933f) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.10] gh-93738: Disallow pre-v3 syntax in the C domain (GH-97962) (#97977)Łukasz Langa2022-10-066-38/+13
| | | | | | | Also, disable using invalid sphinx-lint 0.6.2. (cherry picked from commit f612565bd32d4ab0945798da775eea070f08b6fe) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.10] gh-95691: Doc BufferedWriter and BufferedReader (GH-95703) (#97948)Miss Islington (bot)2022-10-061-1/+1
| | | | | | | | gh-95691: Doc BufferedWriter and BufferedReader (GH-95703) (cherry picked from commit 0d68879104dfb392d31e52e25dcb0661801a0249) Co-authored-by: 180909 <734461790@qq.com> Co-authored-by: 180909 <734461790@qq.com>
* GH-88968: Add notes about socket ownership transfers (GH-97936)Miss Islington (bot)2022-10-052-0/+48
| | | | | (cherry picked from commit 74ea204634f8eb4745afd5cb75c3fe7749cf38b5) Co-authored-by: Guido van Rossum <guido@python.org>
* [3.10] gh-97654: Add auto exception chaining example to tutorial (GH-97703) ↵Miss Islington (bot)2022-10-051-5/+23
| | | | | | | | (#97884) Add auto exception chaining example to tutorial (cherry picked from commit 395b66a0ae5237eec195ca97daaaf8563706ed34) Co-authored-by: Shahriar Heidrich <smheidrich@weltenfunktion.de>
* [3.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C ↵Łukasz Langa2022-10-0531-234/+234
| | | | | | | | | | | type>) (GH-97768) (#97925) :c:type:`<C type>` -> :c:expr:`<C type>` Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit 0031e62973801d34a9e19ab7bb199e9668e32d7b) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.10] gh-93738: Documentation C syntax (Function glob patterns -> literal ↵Miss Islington (bot)2022-10-057-20/+20
| | | | | | | | markup) (GH-97774) (#97911) (cherry picked from commit 0e72606dd4cf3023a4f8c2fe3c58082592b253f7) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* [3.10] gh-93738: Documentation C syntax (:c:type:`PyTypeObject*` -> ↵Miss Islington (bot)2022-10-052-2/+2
| | | | | | | | :c:expr:`PyTypeObject*`) (GH-97778) (#97890) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> (cherry picked from commit c70c8b69762f720377adaf22f2e5ec6496a7be53) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.10] gh-93738: Documentation C syntax (Use `c:struct`) (GH-97772) (#97893)Łukasz Langa2022-10-055-14/+14
| | | | | | Use `c:struct` (cherry picked from commit a0f5599aac2037da715d09733e0a83a9cba7c37a) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.10] gh-93738: Documentation C syntax (:c:type: to :c:expr:, misc. cases) ↵Łukasz Langa2022-10-053-5/+5
| | | | | | | (GH-97775) (#97891) (cherry picked from commit 6b3d4db02edc5883a7e7cbe088711edaef0d9853) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.10] gh-93738: Documentation C syntax (:c:type:`PyObject` -> ↵Miss Islington (bot)2022-10-0510-30/+30
| | | | | | | | :c:expr:`PyObject`) (GH-97776) (#97888) :c:type:`PyObject` -> :c:expr:`PyObject` (cherry picked from commit 0bf6a617ed1832bc4803e532c8d6b3427cf48b13) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* gh-97661: Improve accuracy of sqlite3.Cursor.fetchone docs (GH-97662)Miss Islington (bot)2022-10-051-1/+3
| | | | | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> (cherry picked from commit 4b83cd0b22428fbfccf1f0e85c0fc36be6ab7edf) Co-authored-by: Jia Junjie <62194633+jiajunjie@users.noreply.github.com>
* Add re.VERBOSE flag documentation example (GH-97678)Miss Islington (bot)2022-10-051-1/+2
| | | | | | | | | The current re.VERBOSE documentation example leaves space for ambiguous interpretation. One may read that spaces within the `(?:` token are spaces inside the non-capturing group (such as `(?: )`). This patch removes the ambiguity by including examples after the statement. (cherry picked from commit 0ceafa7fa408b64377ea31dd5386152da19ef38a) Co-authored-by: Athos Ribeiro <athoscribeiro@gmail.com>
* [3.10] gh-93738: Documentation C syntax (:c:type:`PyInterpreterState *` -> ↵Miss Islington (bot)2022-10-051-1/+1
| | | | | | | | :c:expr:`PyInterpreterState *`) (GH-97777) (#97877) :c:type:`PyInterpreterState *` -> :c:expr:`PyInterpreterState *` (cherry picked from commit 4ebb0250314b57637d213cd5bc5f5ce5dd911d94) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.10] gh-93738: Documentation C syntax (:c:data:`view->obj` -> ↵Miss Islington (bot)2022-10-051-5/+5
| | | | | | | | :c:expr:`view->obj`) (GH-97773) (#97868) :c:data:`view->obj` -> :c:expr:`view->obj` (cherry picked from commit fa59bda8d30ea0b6c19007205b57c800c944304c) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.10] gh-93738: Documentation C syntax (:c:type:`TYPE` -> :c:expr:`TYPE`) ↵Miss Islington (bot)2022-10-051-2/+2
| | | | | | | | (GH-97770) (#97870) :c:type:`TYPE` -> :c:expr:`TYPE` (cherry picked from commit 8b211b4cdbcddecfcc4d1682864795b5f1438c59) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.10] gh-93738: Documentation C syntax (:c:type:`FILE` -> :c:expr:`FILE`) ↵Miss Islington (bot)2022-10-053-8/+8
| | | | | | | | (GH-97769) (#97872) :c:type:`FILE` -> :c:expr:`FILE` (cherry picked from commit 192d401ba53224020f5f9ca6e1ff2c9f89511ac4) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.10] gh-93738: Documentation C syntax (:c:type:`PyTupleObject*` -> ↵Miss Islington (bot)2022-10-041-1/+1
| | | | | | | | :c:expr:`PyTupleObject*`) (GH-97780) (#97864) :c:type:`PyTupleObject*` -> :c:expr:`PyTupleObject*` (cherry picked from commit 510baa429affb832d7b4ed68182e59daa2815d2e) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>