summaryrefslogtreecommitdiffstats
path: root/Doc/howto
Commit message (Collapse)AuthorAgeFilesLines
* [3.12] gh-119779: Fix pyporting howto docs (GH-119785) (#119789)Miss Islington (bot)2024-05-301-2/+2
| | | | | | gh-119779: Fix pyporting howto docs (GH-119785) (cherry picked from commit 6fb191be15fd49da10506de29b6393ffdf59b894) Co-authored-by: Awbert <119314310+SweetyAngel@users.noreply.github.com>
* [3.12] docs: fix a few typos identified by codespell (GH-119516) (#119571)Hugo van Kemenade2024-05-261-1/+1
| | | | Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* [3.12] gh-118671: Updated dead ActiveState links (GH-118730) (#118754)Miss Islington (bot)2024-05-081-1/+1
| | | | | | Co-authored-by: trag1c <trag1cdev@yahoo.com> Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
* [3.12] Docs: add link roles with Sphinx extlinks (GH-117850) (#117910)Hugo van Kemenade2024-04-152-9/+6
| | | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] Add 'The Python 2.3 Method Resolution Order' (GH-116435) (#117885)Hugo van Kemenade2024-04-152-1/+672
| | | | Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.12] [doc] Update logging documentation to improve grammar and elucidate ↵Miss Islington (bot)2024-04-041-4/+64
| | | | | an example. (GH-117541) (GH-117542) (cherry picked from commit df912c913a3d94995b379f1e19fe0a79acab6169)
* [3.12] [docs] Fix typo in docstring and add example to logging cookbook. ↵Miss Islington (bot)2024-03-221-14/+126
| | | | | (GH-117157) (GH-117159) (cherry picked from commit 00baaa21de229a6db80ff2b84c2fd6ad1999a24c)
* [3.12] gh-98731: Improvements to the logging documentation (GH-101618) ↵Miss Islington (bot)2024-03-131-77/+41
| | | | | (GH-116734) (cherry picked from commit 7f418fb111dec325b5c9fe6f6e96076049322f02)
* [3.12] [doc]: Update cookbook recipe for Qt6. (GH-116719) (GH-116729)Miss Islington (bot)2024-03-131-13/+36
| | | (cherry picked from commit 186af3cf21705badec086ec16f231ac390747d3b)
* [3.12] gh-89480: Document the gdb helpers (GH-115657) (GH-115857)Miss Islington (bot)2024-02-232-0/+450
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | gh-89480: Document the gdb helpers (GH-115657) Content adapted from https://devguide.python.org/development-tools/gdb/GH- and https://wiki.python.org/moin/DebuggingWithGdb. The original content on the Wiki page came from gdb debug help used by the Launchpad (https://launchpad.net/) team. Thanks to Anatoly Techtonik and user `rmf` for substantial improvements to the Wiki page. The history of the Devguide page follows (with log entries expanded for major content contributions): Hugo van Kemenade, Sat Dec 30 21:22:04 2023 +0200 Hugo van Kemenade, Fri Dec 8 12:04:32 2023 +0200 Erlend E. Aasland & Hugo van Kemenade, Tue Aug 8 22:05:34 2023 +0200 Satish Mishra, Sat Feb 11 13:54:57 2023 +0530 Hugo van Kemenade, Fri Dec 23 17:33:33 2022 +0200 Skip Montanaro, Hugo, Erlend, & Ezio, Fri Nov 4 05:04:23 2022 -0500 Add a GDB tips section to Advanced Tools (GH-977) Adam Turner, Wed Jun 15 21:19:23 2022 +0100 Adam Turner, Tue Jun 14 11:12:26 2022 +0100 Suriyaa, Fri Jun 8 19:39:23 2018 +0200 Jeff Allen, Tue Oct 24 18:12:53 2017 +0100 Jeff Allen, Fri Oct 13 13:43:43 2017 +0100 Mariatta, Wed Jan 4 09:14:55 2017 -0800 Carol Willing, Mon Sep 26 14:50:54 2016 -0700 Zachary Ware, Thu Jul 21 10:42:23 2016 -0500 Georg Brandl, Mon Nov 3 11:28:19 2014 +0100 Add instruction how to activate python-gdb.py Georg Brandl, Sun Mar 9 10:32:01 2014 +0100 Georg Brandl, Tue Apr 3 09:12:53 2012 +0200 Georg Brandl, Sat Mar 5 17:32:35 2011 +0100 Dave Malcolm, Fri Jan 21 12:34:09 2011 -0500 Add documentation on the gdb extension commands provided in libpython.py I adapted this from documentation I wrote for the Fedora wiki: https://fedoraproject.org/wiki/Features/EasierPythonDebuggingGH-New_gdb_commands reformatting it as rst, and making other minor changes Brett Cannon, Thu Jan 20 15:16:52 2011 -0800 Dave Malcolm, Thu Jan 20 16:17:23 2011 -0500 Add some notes on the gdb pretty-printer hooks Antoine Pitrou, Thu Jan 20 21:17:49 2011 +0100 Give an example backtrace Antoine Pitrou, Thu Jan 20 21:03:06 2011 +0100 Expand explanations about gdb support Brett Cannon, Thu Jan 20 11:33:36 2011 -0800 Tweak the gdb support title to fit in better with the devguide. Brett Cannon, Mon Jan 17 21:12:54 2011 +0000 Short README on gdb support. (cherry picked from commit 59057ce55a443f35bfd685c688071aebad7b3671) Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-authored-by: anatoly techtonik <techtonik@gmail.com> Co-authored-by: Antoine Pitrou <solipsis@pitrou.net> Co-authored-by: Brett Cannon <brett@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Dave Malcolm <dmalcolm@redhat.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Georg Brandl <georg@python.org> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Jeff Allen <ja.py@farowl.co.uk> Co-authored-by: Mariatta <Mariatta@users.noreply.github.com> Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Satish Mishra <7506satish@gmail.com> Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com> Co-authored-by: Suriyaa <isc.suriyaa@gmail.com> Co-authored-by: Zachary Ware <zachary.ware@gmail.com>
* [3.12] gh-114785: Remove content from `Porting from Python2` how-to ↵Miss Islington (bot)2024-02-212-411/+19
| | | | | | | | | | | (GH-114805) (GH-115327) Keep the page though, because people might still rely on it (the traffic shows that they do). Instead of our own manual we now give links to the 3rd-party ones. (cherry picked from commit 705c76d4a202f1faf41027d48d44eac0e76bb1f0) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.12] Make the title match the content (GH-115702) (gh-115703)Miss Islington (bot)2024-02-202-5/+5
|
* [3.12] Modernize the Sorting HowTo guide (gh-115479) (gh-115701)Miss Islington (bot)2024-02-201-6/+54
|
* [3.12] gh-115233: Fix an example in the Logging Cookbook (GH-115325) (GH-115355)Serhiy Storchaka2024-02-121-6/+4
| | | | | | Also add more tests for LoggerAdapter. Also support stacklevel in LoggerAdapter._log(). (cherry picked from commit 91822018eeba12a6c9eabbc748363b2fd4291b30)
* [3.12] Update LOGGING example taken from Django docs. (GH-114903) (#114951)Miss Islington (bot)2024-02-031-14/+11
| | | | Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
* [3.12] gh-101100: Fix sphinx warnings in `howto/logging.rst` (GH-114846) ↵Hugo van Kemenade2024-02-011-21/+22
| | | | | | (#114878) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] gh-101100: Fix Sphinx warnings in `howto/urllib2.rst` and ↵Hugo van Kemenade2024-01-141-9/+9
| | | | | `library/http.client.rst` (GH-114060) (#114063) (cherry picked from commit c2808431b32fa7bc0d222d4549389f781f1a7333)
* [3.12] gh-113625: Align object addresses in the Descriptor HowTo Guide ↵Miss Islington (bot)2024-01-101-1/+1
| | | | | | | | (GH-113894) (#113922) gh-113625: Align object addresses in the Descriptor HowTo Guide (GH-113894) (cherry picked from commit 901a971e161e060bd95f3cf3aeebe8b48d6e6dac) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* [3.12] gh-101100: Fix Sphinx warnings in `howto/isolating-extensions.rst` ↵Miss Islington (bot)2023-12-261-2/+2
| | | | | | (GH-113493) (#113497) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] gh-101100: Improve documentation on function attributes (GH-112933) ↵Hugo van Kemenade2023-12-122-4/+7
| | | | | | | (#112974) (cherry picked from commit 4c5b9c107a1d158b245f21a1839a2bec97d05383) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] [Enum] update class creation for RuntimeError changes (GH-111815) ↵Miss Islington (bot)2023-11-291-1/+0
| | | | | | | (GH-112526) (cherry picked from commit f9e6ce03953e9ee988d55324dc715b0ef2303cfb) Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
* [3.12] Descriptor HowTo: Sync the error-messages with the C code. Add ↵Miss Islington (bot)2023-11-251-3/+40
| | | | tests. (gh-112403) (gh-112411)
* [3.12] Remove bogus annotations from the descriptor howto guide (GH-112349) ↵Miss Islington (bot)2023-11-231-3/+3
| | | | | | | | (#112352) Remove bogus annotations from the descriptor howto guide (GH-112349) (cherry picked from commit d9fc15222e96942e30ea8b0561dec5c82ecb4663) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* [3.12] gh-110812: Isolating Extension Modules HOWTO: List GC-related gotchas ↵Miss Islington (bot)2023-11-161-6/+97
| | | | | | | | | | (GH-111504) (GH-112148) gh-110812: Isolating Extension Modules HOWTO: List GC-related gotchas (GH-111504) (cherry picked from commit 985679f05d1b72965bfbed99d1499c22815375e4) Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
* [3.12] Fix typo in perf profiling docs (GH-112112) (#112117)Miss Islington (bot)2023-11-151-1/+1
| | | | | | Fix typo in perf profiling docs (GH-112112) (cherry picked from commit 0cfdd6e3d17fee8c1c1f4b42b2146abcb43aa34b) Co-authored-by: Ryuji Tsutsui <ryu22e+github@gmail.com>
* [3.12] gh-111895: Convert definition list to bullet list for readability on ↵Miss Islington (bot)2023-11-091-6/+6
| | | | | | | | | | mobile (GH-111898) (#111908) gh-111895: Convert definition list to bullet list for readability on mobile (GH-111898) Convert definition list to bullet list for readability on mobile (cherry picked from commit 7d21e3d5ee9858aee570aa6c5b6a6e87d776f4b5) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] Glossary: Add "static type checker" (GH-111837) (#111854)Miss Islington (bot)2023-11-081-2/+3
| | | | | | | Glossary: Add "static type checker" (GH-111837) (cherry picked from commit 8ab7ad63086b1793c24b1c5aaa19b60fc0e6540e) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-111724: Fix doctest `ResourceWarning` in `howto/descriptor.rst` ↵Miss Islington (bot)2023-11-041-0/+4
| | | | | | | | | | (GH-111725) (#111727) gh-111724: Fix doctest `ResourceWarning` in `howto/descriptor.rst` (GH-111725) Close database connection explicitly in test cleanup. (cherry picked from commit f48e669504ce53040a04e0181064c11741a87817) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] gh-111181: Fix enum doctests (GH-111180) (GH-111518)Miss Islington (bot)2023-10-311-3/+6
| | | | | | | gh-111181: Fix enum doctests (GH-111180) (cherry picked from commit c4dc5a6ae8aa13abb743182df088f1a3526d1bcd) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
* [3.12] gh-110383: Italicize variable name (GH-111206) (#111207)Miss Islington (bot)2023-10-231-1/+1
| | | | Co-authored-by: Nick <Nikki1993@users.noreply.github.com>
* [3.12] gh-110383: Added explanation about simplest regex use case for ↵Miss Islington (bot)2023-10-231-0/+3
| | | | | | | quantifiers. (GH-111110) (#111204) Co-authored-by: Nick <Nikki1993@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] GH-107518: Remove the Argument Clinic How-To (#109900) (#110760)Erlend E. Aasland2023-10-122-1892/+5
| | | | | | | | | (cherry picked from commit d1f7fae424d51b0374c8204599583c4a26c1a992) * Remove the content of the Argument Clinic HOWTO * Update cross-references to the Argument Clinic * Add a note directing readers to the devguide Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] gh-110631: Fix reST indentation (GH-110724) (#110738)Ezio Melotti2023-10-112-15/+14
| | | | | | * Fix wrong indentation in the other dirs. * Fix more wrong indentation.. (cherry picked from commit 718391f475f2550d99dd794069ca76312f7f6aa6)
* [3.12] Fix env var typo in perf profiling docs (GH-110404) (#110414)Miss Islington (bot)2023-10-051-2/+1
| | | | | | | | Fix env var typo in perf profiling docs (GH-110404) Fix typo in docs (cherry picked from commit a13620685f68957c965fca89343a0e91f95f1bab) Co-authored-by: Harmen Stoppels <harmenstoppels@gmail.com>
* [3.12] gh-101100: Fix references to ``URLError`` and ``HTTPError`` in ↵Miss Islington (bot)2023-09-291-8/+8
| | | | | | | | | ``howto/urllib2.rst`` (GH-107966) (#110086) gh-101100: Fix references to ``URLError`` and ``HTTPError`` in ``howto/urllib2.rst`` (GH-107966) (cherry picked from commit bfd94ab9e9f4055ecedaa500b46b0270da9ffe12) Co-authored-by: Yuki K <drsuaimqjgar@gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] gh-109634: Use :samp: role (GH-109635) (#109776)Miss Islington (bot)2023-09-242-3/+3
| | | | | | gh-109634: Use :samp: role (GH-109635) (cherry picked from commit 92af0cc580051fd1129c7a86af2cbadeb2aa36dc) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.12] gh-108682: [Enum] raise TypeError if super().__new__ called in custom ↵Miss Islington (bot)2023-08-311-1/+22
| | | | | | | | | | | | | | | | __new__ (GH-108704) (#108733) gh-108682: [Enum] raise TypeError if super().__new__ called in custom __new__ (GH-108704) When overriding the `__new__` method of an enum, the underlying data type should be created directly; i.e. . member = object.__new__(cls) member = int.__new__(cls, value) member = str.__new__(cls, value) Calling `super().__new__()` finds the lookup version of `Enum.__new__`, and will now raise an exception when detected. (cherry picked from commit d48760b2f1e28dd3c1a35721939f400a8ab619b8) Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
* [3.12] gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678) ↵Miss Islington (bot)2023-08-301-4/+11
| | | | | | | | (#108680) gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678) (cherry picked from commit c7cef546319c51defa01236469b636b6978b99ab) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] gh-107432 Update Porting Python 2 Code to Python 3 how-to (GH-107434) ↵Miss Islington (bot)2023-08-241-121/+94
| | | | | | | | | | | | | (#108409) gh-107432 Update Porting Python 2 Code to Python 3 how-to (GH-107434) https://docs.python.org/3/howto/pyporting.htmlGH-porting-python-2-code-to-python-3 was written for another time. In this patch: - material that frames Python 3 as "new" is removed - descriptions and directions have been trimmed (cherry picked from commit 809ea7c4b6c2b818ae510f1f58e82b6b05ed4ef9) Co-authored-by: Daniele Procida <daniele@vurt.org>
* [3.12] docs: fix grammar in isolating-extensions.rst (GH-108037) (#108218)Miss Islington (bot)2023-08-211-1/+1
| | | | | | docs: fix grammar in isolating-extensions.rst (GH-108037) (cherry picked from commit 47022a079eb9d2a2af781abae3de4a71f80247c2) Co-authored-by: David Lechner <david@pybricks.com>
* [3.12] Docs: Argument Clinic: Move the CConverter class to the reference ↵Miss Islington (bot)2023-08-071-64/+69
| | | | | | | | (GH-107671) (#107701) Docs: Argument Clinic: Move the CConverter class to the reference (GH-107671) (cherry picked from commit a6675b1a597c67be972598ac8562883fabe48099) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.12] Docs: Argument Clinic: Improve 'How to write a custom converter' ↵Miss Islington (bot)2023-08-061-24/+26
| | | | | | | | | | | | | (GH-107328) (#107669) Docs: Argument Clinic: Improve 'How to write a custom converter' (GH-107328) - Omit unneccesary wording and sentences - Don't mention implementation details (no digression, explanation) (cherry picked from commit 4a5b4221e381c541f3f73537b7b87580d100158b) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* [3.12] gh-107432 Fix incorrect indentation in annotations HOWTO (GH-107445) ↵Miss Islington (bot)2023-08-051-163/+163
| | | | | | | | | | | | | (#107654) gh-107432 Fix incorrect indentation in annotations HOWTO (GH-107445) gh-107432 Fix incorrect indentation in annotations document Body text in https://docs.python.org/3/howto/annotations.html was indented throughout, and was being rendered in blockquote elements. (cherry picked from commit 5e2746d6e2fb0da29225ead7135f078c5f087b57) Co-authored-by: Daniele Procida <daniele@vurt.org>
* [3.12] gh-107306: Add a Doc Entry for Py_mod_multiple_interpreters ↵Miss Islington (bot)2023-07-311-0/+2
| | | | | | | | | | (GH-107403) (gh-107521) gh-107306: Add a Doc Entry for Py_mod_multiple_interpreters (GH-107403) It was added in 3.12 for PEP 684 (per-interpreter GIL). (cherry picked from commit fb344e99aa0da5bef9318684ade69978585fe060) Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
* [3.12] gh-107507: Replace 'The goals of Argument Clinic' with a summary ↵Miss Islington (bot)2023-07-311-54/+4
| | | | | | | | | (GH-107508) (#107516) Summarise the goals of Argument Clinic in a single sentence. Mention that Argument Clinic was introduced with PEP-436. (cherry picked from commit abb71c6a8f73482c910ffdf050a86089a48e0e60) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.12] gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) ↵Serhiy Storchaka2023-07-291-1/+1
| | | | | (GH-107419) (cherry picked from commit f2d07d3289947d10b065b2bb7670c8fb6b6582f2)
* [3.12] gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345) ↵Serhiy Storchaka2023-07-281-5/+5
| | | | | (GH-107380) (cherry picked from commit 983305268e2291b0a7835621b81bf40cba7c27f3)
* [3.12] Docs: Argument Clinic: Restructure "Basic concepts and usage" ↵Miss Islington (bot)2023-07-271-43/+129
| | | | | | | | | | | | | | | | | | | (GH-106981) (#107325) Split "Basic concepts and usage" into: - Reference - Terminology - CLI reference - Background - Basic concepts (cherry picked from commit 2ad699002e3ce09e9fa41e333ac72f16a32d94de) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* [3.12] Docs: Remove the numbered steps from the Argument Clinic tutorial ↵Miss Islington (bot)2023-07-261-314/+310
| | | | | | | | | | (GH-107203) (#107317) Instead, order the tutorial as one body of prose, making it easier to align the tutorial according to Diátaxis principles. (cherry picked from commit 592395577c679543d899e68a3cff538b8b4df80d) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.12] gh-107091: Fix some uses of :c:member: role (GH-107129) (GH-107310)Miss Islington (bot)2023-07-261-1/+1
| | | | | (cherry picked from commit af61cb9c7837ff3c11da79e3ee1cab3fdd0ba4da) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
generated by cgit v0.12 at 2025-01-10 05:24:45 (GMT)